Class AbstractLayoutAttribute
Abstract base class for auxiliary extension attributes that specify the location of plug-in items on a command bar.
Inheritance
Implements
Namespace: Sdl.Desktop.IntegrationApi.Extensions
Assembly: Sdl.Desktop.IntegrationApi.Extensions.dll
Syntax
public abstract class AbstractLayoutAttribute : AuxiliaryExtensionAttribute, ILocationAware
Constructors
AbstractLayoutAttribute()
Default constructor for XML serialization.
Declaration
protected AbstractLayoutAttribute()
AbstractLayoutAttribute(Type)
Constructor using the target command bar path.
Declaration
protected AbstractLayoutAttribute(Type locationType)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Type | locationType | The location by type at which to insert the plug-in item. |
Properties
DisplayType
The visual representation type.
Declaration
public DisplayType DisplayType { get; set; }
Property Value
| Type | Description |
|---|---|
| DisplayType |
IsSeparator
Declaration
public bool IsSeparator { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
LocationByType
The type of the location where the UI element is positioned.
Declaration
public Type LocationByType { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Type |
Name
An instance specific name, overriding the default Name, which should be used for this instance. This only has an effect for instances of actions. Can be null.
Declaration
public string Name { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
ZIndex
Defines a 0 based index order for the UI elements where the highest value is the most important.
Declaration
public uint ZIndex { get; set; }
Property Value
| Type | Description |
|---|---|
| System.UInt32 |
Remarks
The z-Index ordering is performed only for the intergrated elements and have a lower priority than SDL ordering. It acts as importance from left to right or top to bottom.
The highest ZIndex value is in the left or top and the lowest value is in the right or bottom.