Class ComplexDefinitionAttribute
Can be marked against an interface to indicate this is a complex type used by LemonEdge and can be used in queries and the web service
Inheritance
Inherited Members
Namespace: LemonEdge.API.Attributes
Assembly: API.dll
Syntax
[AttributeUsage(AttributeTargets.Class | AttributeTargets.Interface, Inherited = false, AllowMultiple = false)]
public sealed class ComplexDefinitionAttribute : Attribute
Remarks
For Example:
[Attributes.ComplexDefinition(Client.Core.Images.ImageType.LemonEdge, "My Complex Type")]
public interface IMyComplexType
{
public string ValueB { get; set; }
public int ValueA { get; set; }
}
Constructors
ComplexDefinitionAttribute(ImageType, String)
Indicates this class or interface holds a complex type that can be used in queries and the web service using the specified default image
and label
Declaration
public ComplexDefinitionAttribute(ImageType image, string label)
Parameters
Type | Name | Description |
---|---|---|
ImageType | image | The default image used when the system shows the complex type in a result |
System.String | label | The default label to use when referring to this complex type |
ComplexDefinitionAttribute(String, String)
Indicates this class or interface holds a complex type that can be used in queries and the web service using the specified default image
and label
Declaration
public ComplexDefinitionAttribute(string imageID, string label)
Parameters
Type | Name | Description |
---|---|---|
System.String | imageID | |
System.String | label | The default label to use when referring to this complex type |
See Also
Properties
HelpURL
An optional url of a help file explaining this complex type and its functionality
Declaration
public string HelpURL { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Image
The id of the image to use when displaying this complex type to the user
Declaration
public Guid Image { get; }
Property Value
Type | Description |
---|---|
System.Guid |
Label
The default label to use when referring to this complex type
Declaration
public string Label { get; }
Property Value
Type | Description |
---|---|
System.String |