Class ViewDescriptorInstance
A class responsible for holding the description of an instance of a IModelView to be created within a layout
This includes an custom parameters for the view itself along with parameters for the type of view
Inherited Members
Namespace: LemonEdge.Client.Core.Views.Core
Assembly: LemonEdge.Client.UI.API.dll
Syntax
[DataContract(IsReference = true)]
public class ViewDescriptorInstance : ICloneable, ICloneable<ViewDescriptorInstance>Constructors
ViewDescriptorInstance()
Declaration
public ViewDescriptorInstance()Properties
DisplayableItemType
The type of item this view accepts as a valid object to work with and is valid to be passed into the LemonEdge.Client.Core.Views.Core.ModelViewController.DisplayItem(object) method
Declaration
public Type DisplayableItemType { get; set; }Property Value
| Type | Description |
|---|---|
| Type |
HelpURL
An overriden help url for this view
Declaration
public string? HelpURL { get; set; }Property Value
| Type | Description |
|---|---|
| string |
IconID
An icon to use when displaying the view in the displayer ui
Declaration
public Guid IconID { get; set; }Property Value
| Type | Description |
|---|---|
| Guid |
Name
The user friendly name of this view seen by the user in the layout displayer
Declaration
public string? Name { get; set; }Property Value
| Type | Description |
|---|---|
| string |
Param
The standard parameters for the view itself including visibility options
This class can be inherited by views to provide additional custom properties for each view as required
Declaration
public ViewSerializedParam Param { get; set; }Property Value
| Type | Description |
|---|---|
| ViewSerializedParam |
Parent
The parent view for this view. The view must be in the same layout definition.
When the parent view changes its LemonEdge.Client.Core.Views.Core.ModelViewController.SelectedItemForSubViews, the IModelLayoutDisplayer will pass that new item to this view to display
Declaration
public ViewDescriptorInstance? Parent { get; set; }Property Value
| Type | Description |
|---|---|
| ViewDescriptorInstance |
SelectableType
The type of item this view can select and return for dependant sub views through LemonEdge.Client.Core.Views.Core.ModelViewController.SelectedItemForSubViews
Declaration
public Type SelectableType { get; set; }Property Value
| Type | Description |
|---|---|
| Type |
ViewControllerName
Optional - The name of the controller associated with the view to be created
This provides the ability for you to provide a custom controller for a standard view by inheriting the controller, and specify its name here so the view uses that controller instead of the standard one
Declaration
public string? ViewControllerName { get; set; }Property Value
| Type | Description |
|---|---|
| string |
ViewCreationParam
Optional parameters used by CreateView(ViewDescriptorInstance) to determine the exact instance of the IModelView to create
Declaration
public string? ViewCreationParam { get; set; }Property Value
| Type | Description |
|---|---|
| string |
ViewType
The IModelView type of the actual view
Declaration
public Type ViewType { get; set; }Property Value
| Type | Description |
|---|---|
| Type |
Methods
CanDisplayItem(object)
Evaluates if the specified object is valid to be displayed against this view type as determined by the DisplayableItemType property
Declaration
public bool CanDisplayItem(object item)Parameters
| Type | Name | Description |
|---|---|---|
| object | item | The type of item to see if it is valid to display against this view |
Returns
| Type | Description |
|---|---|
| bool | True if the specified object is valid to be displayed against this view type as determined by the DisplayableItemType property |
Clone()
Creates a new instance of this class (of type ViewDescriptorInstance) with all the same property values as this instance
Declaration
public ViewDescriptorInstance Clone()Returns
| Type | Description |
|---|---|
| ViewDescriptorInstance | A new instance of this class with all the same property values as this instance |
CopyFromSource(ViewDescriptorInstance)
Updates all properties in this item to have the same properties as the source object.
Declaration
public void CopyFromSource(ViewDescriptorInstance source)Parameters
| Type | Name | Description |
|---|---|---|
| ViewDescriptorInstance | source | The source object to copy all values from. |
ToString()
Declaration
public override string ToString()Returns
| Type | Description |
|---|---|
| string |