Class ViewPartLayoutAttribute

An auxiliary extension attribute for use with the ViewPartAttribute to define a view part. This extension can be used to specify a default layout for the view part, but also to specify a layout specific to a certain view configuration. Multiple instances of this attribute can be applied.

Inheritance
System.Object
AbstractLayoutAttribute
ViewPartLayoutAttribute
Implements
Inherited Members
Namespace: Sdl.Desktop.IntegrationApi.Extensions
Assembly: Sdl.Desktop.IntegrationApi.Extensions.dll
Syntax
[AttributeUsage(AttributeTargets.Class, AllowMultiple = true)]
public sealed class ViewPartLayoutAttribute : AbstractLayoutAttribute, ILocationAware

Constructors

ViewPartLayoutAttribute()

Default constructor

Declaration
public ViewPartLayoutAttribute()

ViewPartLayoutAttribute(Type)

Initialize the viewpart layout instance

Declaration
public ViewPartLayoutAttribute(Type locationByType)
Parameters
Type Name Description
System.Type locationByType

The location where the viewpart will be added.

Remarks

You may use as a locationByType

Properties

ConfigurationType

Gets or sets the id of the configuration within the target view to which this layout applies. If ommitted, this layout is the default layout.

Declaration
public Type ConfigurationType { get; set; }
Property Value
Type Description
System.Type

CreateNewGroup

Gets or sets whether to create a new docking group. When set to true, the new docking group is created positioned relatively to the view parts specified by ZIndex. The new group is positioned relatively to the existing panes according to the ParentGroupStyle property.

Declaration
public bool CreateNewGroup { get; set; }
Property Value
Type Description
System.Boolean

Dock

Gets or sets the preferred location within the view in which the view part should appear, in case no view parts are specified in ZIndex or in case these view parts are not open in the view.

Declaration
public DockType Dock { get; set; }
Property Value
Type Description
DockType

GroupStyle

Gets or sets the preferred way this view part should be grouped with other view parts in the same area (see Dock), in case no view parts are specified in ZIndex or in case these view parts are not open in the view.

Declaration
public GroupStyle GroupStyle { get; set; }
Property Value
Type Description
GroupStyle

Height

Gets or sets the preferred height of the view part in case this is not already implied by the way view parts are grouped in the group to which the view parts, specified in ZIndex, belong to.

Declaration
public int Height { get; set; }
Property Value
Type Description
System.Int32

MinHeight

Gets or sets whether the minimum height of the view part.

Declaration
public int MinHeight { get; set; }
Property Value
Type Description
System.Int32

MinWidth

Gets or sets whether the minimum width of the view part.

Declaration
public int MinWidth { get; set; }
Property Value
Type Description
System.Int32

ParentGroupStyle

Gets or sets the group style used when creating a new CreateNewGroup is set to true. Refer to CreateNewGroup for more information.

Declaration
public GroupStyle ParentGroupStyle { get; set; }
Property Value
Type Description
GroupStyle

Pinned

Gets or sets whether the view part should be pinned. True by default.

Declaration
public bool Pinned { get; set; }
Property Value
Type Description
System.Boolean

Visible

Gets or sets whether this view part is visible by default. True by default.

Declaration
public bool Visible { get; set; }
Property Value
Type Description
System.Boolean

Width

Gets or sets the preferred width of the view part in case this is not already implied by the way view parts are grouped in the group to which the view parts, specified in ZIndex, belong to.

Declaration
public int Width { get; set; }
Property Value
Type Description
System.Int32

Implements

Extension Methods