ViewPartLayoutAttribute Class

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 Hierarchy

SystemObject
  SystemAttribute
    Sdl.Core.PluginFrameworkAuxiliaryExtensionAttribute
      Sdl.Desktop.IntegrationApi.ExtensionsAbstractLayoutAttribute
        Sdl.Desktop.IntegrationApi.ExtensionsViewPartLayoutAttribute

Namespace: Sdl.Desktop.IntegrationApi.Extensions
Assembly: Sdl.Desktop.IntegrationApi.Extensions (in Sdl.Desktop.IntegrationApi.Extensions.dll) Version: 4.0.0.0 (4.2.2764.0)

Syntax

C++

Copy

public sealed class ViewPartLayoutAttribute : AbstractLayoutAttribute

Public NotInheritable Class ViewPartLayoutAttribute
	Inherits AbstractLayoutAttribute

public ref class ViewPartLayoutAttribute sealed : public AbstractLayoutAttribute

[<SealedAttribute>]
type ViewPartLayoutAttribute =  
    class
        inherit AbstractLayoutAttribute
    end

The ViewPartLayoutAttribute type exposes the following members.

Constructors

	Name	Description
	ViewPartLayoutAttribute	Default constructor
	ViewPartLayoutAttribute(Type)	Initialize the viewpart layout instance

Top

Properties

	Name	Description
	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.
	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.
	DisplayType	The visual representation type. (Inherited from AbstractLayoutAttribute.)
	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.
	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.
	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.
	IsSeparator	(Inherited from AbstractLayoutAttribute.)
	LocationByType	The type of the location where the UI element is positioned. (Inherited from AbstractLayoutAttribute.)
	MinHeight	Gets or sets whether the minimum height of the view part.
	MinWidth	Gets or sets whether the minimum width of the view part.
	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. (Inherited from AbstractLayoutAttribute.)
	ParentGroupStyle	Gets or sets the group style used when creating a new CreateNewGroup is set to true. Refer to CreateNewGroup for more information.
	Pinned	Gets or sets whether the view part should be pinned. True by default.
	Visible	Gets or sets whether this view part is visible by default. True by default.
	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.
	ZIndex	Defines a 0 based index order for the UI elements where the highest value is the most important. (Inherited from AbstractLayoutAttribute.)

Top

Reference

Sdl.Desktop.IntegrationApi.Extensions Namespace

Community

Edit

Be the first to Edit the community content of this topic.

Comments

Send comments on this topic to https://community.sdl.com/developers/language-developers/