PartAlignment Property, GenericPartClass Class


	PartAlignment Property, GenericPartClass Class	Softel vdm, Inc.

Defines the part alignment of this part relative to its container and other parts.

Syntax GenericPartClass Class (Softelvdm.Controls)

VB	Public Property PartAlignment As PartAlignmentEnum
C#	public PartAlignmentEnum PartAlignment { get; set; }
C++	public: property PartAlignmentEnum PartAlignment { PartAlignmentEnum get(); void set(PartAlignmentEnum value); }

Property Value

The part alignment.

PartAlignmentEnum

Value

Description

EntireArea
0
The part occupies the entire cell. In this case, only one part should be present in the CellBaseClass.Parts collection.
This alignment is best suited for parts such as a progressbar (ProgressBarPartClass) that fills the entire cell.

FlushStart
1
Horizontal Layout (CellBaseClass.Orientation): The part starts at the left edge of the remaining cell space and extends to the right. It is flush left-aligned within the cell, without any gap horizontally or vertically.
Vertical Layout (CellBaseClass.Orientation): The part starts at the top edge of the remaining cell space and extends down. It is top-aligned within the cell, without any gap horizontally or vertically.
This alignment is best suited for parts such as a dropdown button (DropDownButtonPartClass) that must be at the edge of the cell and that fill the cell completely (in height for a horizontal layout or in width for a vertical layout).

StartingEdge
2
Horizontal Layout (CellBaseClass.Orientation): The part starts at the left edge of the remaining cell space and extends to the right. It is flush left-aligned within the cell, without any gap horizontally. Vertically, the available space is restricted by the top and bottom gap (defined using the PartsTopEdge and PartsBottomEdge properties).
Vertical Layout (CellBaseClass.Orientation): The part starts at the top edge of the cell and extends down. It is top-aligned within the cell, without any gap vertically. Horizontally, the available space is restricted by the left and right gap (defined using the PartsLeftEdge and PartsRightEdge properties).

Near
3
Horizontal Layout (CellBaseClass.Orientation): A left gap (see PartsLeftEdge) starts at the left edge of the remaining cell space and is followed by the part, which extends to the right. Vertically, the available space is restricted by the top and bottom gap (defined using the PartsTopEdge and PartsBottomEdge properties).
Vertical Layout (CellBaseClass.Orientation): A top gap (PartsTopEdge) starts at the top edge of the remaining cell space and is followed by the part, which extends down. Horizontally, the available space is restricted by the left and right gap (defined using the PartsLeftEdge and PartsRightEdge properties).

Center
4
Horizontal Layout (CellBaseClass.Orientation): The part is horizontally centered within the remaining interior cell space and is followed by a right gap (see PartsRightEdge). Vertically, the available space is restricted by the top and bottom gap (defined using the PartsTopEdge and PartsBottomEdge properties).
Vertical Layout (CellBaseClass.Orientation): The part is vertically centered within the remaining interior cell space and is followed by a bottom gap (see PartsBottomEdge). Horizontally, the available space is restricted by the left and right gap (defined using the PartsLeftEdge and PartsRightEdge properties).

Far
5
Horizontal Layout (CellBaseClass.Orientation): A right gap (see PartsRightEdge) starts at the right edge of the remaining interior cell space and is preceded by the part, which extends to the left. Vertically, the available space is restricted by the top and bottom gap (defined using the PartsTopEdge and PartsBottomEdge properties).
Vertical Layout (CellBaseClass.Orientation): A bottom gap (see PartsBottomEdge) starts at the bottom edge of the remaining interior cell space and is preceded by the part, which extends up. Horizontally, the available space is restricted by the left and right gap (defined using the PartsLeftEdge and PartsRightEdge properties).

EndingEdge
6
Horizontal Layout (CellBaseClass.Orientation): A right gap (see PartsRenderingClass.SetEdges) starts at the right edge of the remaining interior cell space and is preceded by the part, which extends to the left. Vertically, the available space is restricted by the top and bottom gap (defined using the PartsTopEdge and PartsBottomEdge properties).
Vertical Layout (CellBaseClass.Orientation): A bottom gap (see PartsBottomEdge) starts at the bottom edge of the remaining interior cell space and is preceded by the part, which extends up. Horizontally, the available space is restricted by the left and right gap (defined using the PartsLeftEdge and PartsRightEdge properties).

FlushEnd
7
Horizontal Layout (CellBaseClass.Orientation): The part starts at the right edge of the remaining interior cell space and extends to the left. It is flush right-aligned within the cell, without any gap horizontally or vertically.
Vertical Layout (CellBaseClass.Orientation): The part starts at the bottom edge of the remaining interior cell space and extends up. It is bottom-aligned within the cell, without any gap horizontally or vertically.
This alignment is best suited for parts such as a dropdown button (DropDownButtonPartClass) that must be at the edge of the cell and that fill the cell completely (in height).

The default value is PartAlignmentEnum.Near.

Comments

The PartAlignment property defines the part alignment of this part relative to its container and other parts.

The order of the parts within the cell's parts collection determines the display order in the cell, but only for groups of parts that have the same PartAlignment property.

Parts are allocated space within the cell in the following order:

EntireArea - One part takes up the entire space.
FlushStart - The parts are lined up starting at the left/top exterior edge of the cell.
FlushEnd - The parts are lined up starting at the right/bottom exterior edge of the cell.
StartingEdge - The parts are lined up starting at the left/top edge of the cell's interior space.
EndingEdge - The parts are lined up starting at the right/bottom edge of the cell's interior space.
Near - The parts are lined up starting at the left/top edge of the remaining interior space, with a suitable gap.
Far - The parts are lined up starting at the right/top edge of the remaining interior space, with a suitable gap.
Center - The parts are centered within the remaining interior space.

Version Information

Supported in version 1.0.
Products Table

PartAlignmentEnum	Value	Description
EntireArea	0	The part occupies the entire cell. In this case, only one part should be present in the CellBaseClass.Parts collection. This alignment is best suited for parts such as a progressbar (ProgressBarPartClass) that fills the entire cell.
FlushStart	1	Horizontal Layout (CellBaseClass.Orientation): The part starts at the left edge of the remaining cell space and extends to the right. It is flush left-aligned within the cell, without any gap horizontally or vertically. Vertical Layout (CellBaseClass.Orientation): The part starts at the top edge of the remaining cell space and extends down. It is top-aligned within the cell, without any gap horizontally or vertically. This alignment is best suited for parts such as a dropdown button (DropDownButtonPartClass) that must be at the edge of the cell and that fill the cell completely (in height for a horizontal layout or in width for a vertical layout).
StartingEdge	2	Horizontal Layout (CellBaseClass.Orientation): The part starts at the left edge of the remaining cell space and extends to the right. It is flush left-aligned within the cell, without any gap horizontally. Vertically, the available space is restricted by the top and bottom gap (defined using the PartsTopEdge and PartsBottomEdge properties). Vertical Layout (CellBaseClass.Orientation): The part starts at the top edge of the cell and extends down. It is top-aligned within the cell, without any gap vertically. Horizontally, the available space is restricted by the left and right gap (defined using the PartsLeftEdge and PartsRightEdge properties).
Near	3	Horizontal Layout (CellBaseClass.Orientation): A left gap (see PartsLeftEdge) starts at the left edge of the remaining cell space and is followed by the part, which extends to the right. Vertically, the available space is restricted by the top and bottom gap (defined using the PartsTopEdge and PartsBottomEdge properties). Vertical Layout (CellBaseClass.Orientation): A top gap (PartsTopEdge) starts at the top edge of the remaining cell space and is followed by the part, which extends down. Horizontally, the available space is restricted by the left and right gap (defined using the PartsLeftEdge and PartsRightEdge properties).
Center	4	Horizontal Layout (CellBaseClass.Orientation): The part is horizontally centered within the remaining interior cell space and is followed by a right gap (see PartsRightEdge). Vertically, the available space is restricted by the top and bottom gap (defined using the PartsTopEdge and PartsBottomEdge properties). Vertical Layout (CellBaseClass.Orientation): The part is vertically centered within the remaining interior cell space and is followed by a bottom gap (see PartsBottomEdge). Horizontally, the available space is restricted by the left and right gap (defined using the PartsLeftEdge and PartsRightEdge properties).
Far	5	Horizontal Layout (CellBaseClass.Orientation): A right gap (see PartsRightEdge) starts at the right edge of the remaining interior cell space and is preceded by the part, which extends to the left. Vertically, the available space is restricted by the top and bottom gap (defined using the PartsTopEdge and PartsBottomEdge properties). Vertical Layout (CellBaseClass.Orientation): A bottom gap (see PartsBottomEdge) starts at the bottom edge of the remaining interior cell space and is preceded by the part, which extends up. Horizontally, the available space is restricted by the left and right gap (defined using the PartsLeftEdge and PartsRightEdge properties).
EndingEdge	6	Horizontal Layout (CellBaseClass.Orientation): A right gap (see PartsRenderingClass.SetEdges) starts at the right edge of the remaining interior cell space and is preceded by the part, which extends to the left. Vertically, the available space is restricted by the top and bottom gap (defined using the PartsTopEdge and PartsBottomEdge properties). Vertical Layout (CellBaseClass.Orientation): A bottom gap (see PartsBottomEdge) starts at the bottom edge of the remaining interior cell space and is preceded by the part, which extends up. Horizontally, the available space is restricted by the left and right gap (defined using the PartsLeftEdge and PartsRightEdge properties).
FlushEnd	7	Horizontal Layout (CellBaseClass.Orientation): The part starts at the right edge of the remaining interior cell space and extends to the left. It is flush right-aligned within the cell, without any gap horizontally or vertically. Vertical Layout (CellBaseClass.Orientation): The part starts at the bottom edge of the remaining interior cell space and extends up. It is bottom-aligned within the cell, without any gap horizontally or vertically. This alignment is best suited for parts such as a dropdown button (DropDownButtonPartClass) that must be at the edge of the cell and that fill the cell completely (in height).