Class GridTreeColumn

Holds the information that specifies a visible column in the GridTreeControl.

Inheritance
System.Object
GridTreeColumn
GridTreeUnboundColumn
Implements
Namespace: Syncfusion.Windows.Controls.Grid
Assembly: Syncfusion.Grid.Wpf.dll
Syntax
public class GridTreeColumn : DependencyObject, IPercentWidth

Constructors

GridTreeColumn()

Default constructor.

Declaration
public GridTreeColumn()

GridTreeColumn(String)

Declaration
public GridTreeColumn(string mappingName)
Parameters
Type Name Description
System.String mappingName

GridTreeColumn(String, Double)

Declaration
public GridTreeColumn(string mappingName, double width)
Parameters
Type Name Description
System.String mappingName
System.Double width

GridTreeColumn(String, String, Double)

Contructor.

Declaration
public GridTreeColumn(string mappingName, string headerText, double width)
Parameters
Type Name Description
System.String mappingName

The mapping name associated with this column.
System.String headerText

The text to be displayed in the header cell.
System.Double width

The width of this column.
Remarks

The MappingName should uniquely identify a property in the items for this tree. This is normally the PropertyName of the value.

Fields

IsUnboundProperty

Declaration
public static readonly DependencyProperty IsUnboundProperty
Field Value
Type
System.Windows.DependencyProperty

ReferenceFieldsProperty

Declaration
public static readonly DependencyProperty ReferenceFieldsProperty
Field Value
Type
System.Windows.DependencyProperty

Properties

AllowSort

Gets or sets the width of the column.

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

HeaderText

Gets or sets the text that you want to see in the columns headers if they are visible.

Declaration
public string HeaderText { get; set; }
Property Value
Type
System.String

MappingName

Gets or sets the property name of the object assoicated with this column.

Declaration
public string MappingName { get; set; }
Property Value
Type
System.String

PercentWidth

Gets or sets the percentage weight for this column.

Declaration
public double PercentWidth { get; set; }
Property Value
Type
System.Double
Remarks

The default value is double.MinValue which indicates that this column is not to be included in the variable width columns whose size will change to fill the client area of the GridControl. Columns whose values are other than double.MinValue will have their columns widths changed so the entire client area is filled with columns. The algorithm that computes the width first sums the widths of all columns whose value PercentWidth value is double.MinValue. Using this sum, the width of the remaining client area is determined, and that remaining width is allcated to the percent columns based on the PercentWeight value. So, if there are 3 columns whose PercentWeight values are set to 1, 1 and 2 respectively, then the widths of the first 2 columns will be each set to 25% of the remaining space, and the last column width will be set to 50% of the remaining space.

ReferenceFields

Declaration
public string ReferenceFields { get; set; }
Property Value
Type
System.String

StyleInfo

Gets or sets the GridStyleInfo object that defines style properties to be applied to cells in this column.

Declaration
public GridStyleInfo StyleInfo { get; set; }
Property Value
Type
GridStyleInfo

Width

Gets or sets the width of the column.

Declaration
public double Width { get; set; }
Property Value
Type
System.Double

Implements