LayoutDefinition Class

Spotfire 14.3 API Reference

Defines the layout structure and content to be applied within a Page.

Inheritance Hierarchy

SystemObject
Spotfire.Dxp.Application.LayoutLayoutDefinition

Namespace: Spotfire.Dxp.Application.Layout
Assembly: Spotfire.Dxp.Application (in Spotfire.Dxp.Application.dll) Version: 65.0.19510.3242 (65.0.19510.3242)

Syntax

Copy

public sealed class LayoutDefinition

The LayoutDefinition type exposes the following members.

Constructors

	Name	Description
	LayoutDefinition	Initializes a new instance of the LayoutDefinition class.

Top

Methods

	Name	Description
	Add(Visual)	Adds the specified Visual to the current section. BeginStackedSection or BeginSideBySideSection should be called prior to this.
	Add(Visual, Single)	Adds the specified Visual to the current section. BeginStackedSection or BeginSideBySideSection should be called prior to this.
	BeginSideBySideSection	Creates a side-by-side (vertical) section that will be used for subsequent calls to to Add(Visual) or Add(Visual, Single). The section should be ended by calling EndSection.
	BeginSideBySideSection(Single)	Creates a side-by-side (vertical) section that will be used for subsequent calls to to Add(Visual) or Add(Visual, Single). The section should be ended by calling EndSection.
	BeginStackedSection	Creates a stacked (horizontal) section that will be used for subsequent calls to Add(Visual) or Add(Visual, Single). The section should be closed by calling EndSection.
	BeginStackedSection(Single)	Creates a stacked (horizontal) section that will be used for subsequent calls to to Add(Visual) or Add(Visual, Single). The section should be closed by calling EndSection.
	EndSection	Ends the current section. All sections must be ended.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Remarks

Each BeginStackedSection/BeginSideBySideSection call splits the space available into two sections either vertically or horizontally. Space within a section is divided amongst the visuals that are actually added so if we make five subsections and only add a visual to one of them it will take the entire space of all the sections.

Examples

Copy

public void TwoLevelsStartingHorizontally()
{
    // + - + - + - +
    // | 1 | 2 | 3 |
    // + - + - + - +
    // |     4     |
    // + - - - - - +

    Visual v1 = new VisualMock();
    Visual v2 = new VisualMock();
    Visual v3 = new VisualMock();
    Visual v4 = new VisualMock();

    LayoutDefinition ld = new LayoutDefinition();
    ld.BeginStackedSection();
        ld.BeginSideBySideSection();
            ld.Add(v1);
            ld.Add(v2);
            ld.Add(v3);
        ld.EndSection();
        ld.Add(v4);
    ld.EndSection();
}

Copy

public void ThreeLevelsStartingVertically()
{
    // + - - - + - + - +
    // |       |   2   |
    // |       + - + - +
    // |   1   |   3   |
    // |       + - + - +
    // |       | 4 | 5 |
    // + - - - + - + - +

    Visual v1 = new VisualMock();
    Visual v2 = new VisualMock();
    Visual v3 = new VisualMock();
    Visual v4 = new VisualMock();
    Visual v5 = new VisualMock();

    LayoutDefinition ld = new LayoutDefinition();
    ld.BeginSideBySideSection();
        ld.Add(v1);
        ld.BeginStackedSection();
            ld.Add(v2);
            ld.Add(v3);
            ld.BeginSideBySideSection();
                ld.Add(v4);
                ld.Add(v5);
            ld.EndSection();
        ld.EndSection();
    ld.EndSection();
}

Version Information

Supported in: 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8

Reference

Spotfire.Dxp.Application.Layout Namespace