Class TreeColumnAdvStyleInfo
Represents an appearance and behavior information regarding the TreeColumnAdv.
Inheritance
Implements
Inherited Members
Namespace: Syncfusion.Windows.Forms.Tools.MultiColumnTreeView
Assembly: Syncfusion.Tools.Windows.dll
Syntax
public class TreeColumnAdvStyleInfo : StyleInfoSubObjectBase, ICustomTypeDescriptor, IDisposable, IStyleInfo, ISupportInitialize, IFormattable, IConvertible, IXmlSerializable, IStyleInfoSubObject
Constructors
TreeColumnAdvStyleInfo()
Initialize a new instance of the TreeColumnAdvStyleInfo class.
Declaration
public TreeColumnAdvStyleInfo()
TreeColumnAdvStyleInfo(StyleInfoSubObjectIdentity)
Initialize a new instance of the TreeColumnAdvStyleInfo class.
Declaration
public TreeColumnAdvStyleInfo(StyleInfoSubObjectIdentity identity)
Parameters
Type | Name | Description |
---|---|---|
StyleInfoSubObjectIdentity | identity | A Syncfusion.Windows.Forms.Tools.MultiColumnTreeView.TreeColumnAdvStyleInfoIdentity that holds the indentity for this TreeColumnAdvStyleInfo. |
TreeColumnAdvStyleInfo(StyleInfoSubObjectIdentity, TreeColumnAdvStyleInfoStore)
Initializes a new instance of the TreeColumnAdvStyleInfo class.
Declaration
public TreeColumnAdvStyleInfo(StyleInfoSubObjectIdentity identity, TreeColumnAdvStyleInfoStore store)
Parameters
Type | Name | Description |
---|---|---|
StyleInfoSubObjectIdentity | identity | A Syncfusion.Windows.Forms.Tools.MultiColumnTreeView.TreeColumnAdvStyleInfoIdentity that holds the indentity for this TreeColumnAdvStyleInfo. |
TreeColumnAdvStyleInfoStore | store |
TreeColumnAdvStyleInfo(TreeColumnAdvStyleInfo)
Initialize a new instance of the TreeColumnAdvStyleInfo class.
Declaration
public TreeColumnAdvStyleInfo(TreeColumnAdvStyleInfo style)
Parameters
Type | Name | Description |
---|---|---|
TreeColumnAdvStyleInfo | style | The style object that contains the original data. |
TreeColumnAdvStyleInfo(TreeColumnAdvStyleInfoStore)
Initialize a new instance of the TreeColumnAdvStyleInfo class.
Declaration
public TreeColumnAdvStyleInfo(TreeColumnAdvStyleInfoStore store)
Parameters
Type | Name | Description |
---|---|---|
TreeColumnAdvStyleInfoStore | store | A TreeColumnAdvStyleInfoStore that holds data for this TreeColumnAdvStyleInfo. All changes in this style object will be saved in the TreeColumnAdvStyleInfoStore object. |
Properties
AllowTextOverlap
Gets or sets the column text drawing mode.
Declaration
public bool AllowTextOverlap { get; set; }
Property Value
Type |
---|
System.Boolean |
AreaBackground
Gets or sets the background for column area reserved by control.
Declaration
public BrushInfo AreaBackground { get; set; }
Property Value
Type |
---|
BrushInfo |
BackColor
Gets or sets the BackColor of column.
Declaration
[ThemeStudio]
public Color BackColor { get; set; }
Property Value
Type |
---|
System.Drawing.Color |
Background
Gets or sets the Background style of column.
Declaration
public BrushInfo Background { get; set; }
Property Value
Type |
---|
BrushInfo |
BackgroundImage
Gets or sets image that will be painted in the background of the column.
Declaration
public Image BackgroundImage { get; set; }
Property Value
Type |
---|
System.Drawing.Image |
BaseStyle
Gets or sets the base style for the subitem.
Declaration
public string BaseStyle { get; set; }
Property Value
Type |
---|
System.String |
Border3DStyle
Gets or sets the border three dimensional style for the column.
Declaration
public Border3DStyle Border3DStyle { get; set; }
Property Value
Type |
---|
System.Windows.Forms.Border3DStyle |
BorderColor
Gets or sets the border color for the column.
Declaration
public Color BorderColor { get; set; }
Property Value
Type |
---|
System.Drawing.Color |
BorderSides
Gets or sets the sides of a rectangle to apply three dimensional border.
Declaration
public Border3DSide BorderSides { get; set; }
Property Value
Type |
---|
System.Windows.Forms.Border3DSide |
BorderSingle
Gets or sets the border style for the column.
Declaration
public ButtonBorderStyle BorderSingle { get; set; }
Property Value
Type |
---|
System.Windows.Forms.ButtonBorderStyle |
BorderStyle
Gets or sets the border style for the column.
Declaration
public BorderStyle BorderStyle { get; set; }
Property Value
Type |
---|
System.Windows.Forms.BorderStyle |
Comparer
Gets or sets the IComparer object that compares two columns.
Declaration
public IComparer Comparer { get; set; }
Property Value
Type |
---|
System.Collections.IComparer |
Default
Gets a TreeNodeAdvStyleInfo with default settings.
Declaration
public static TreeColumnAdvStyleInfo Default { get; }
Property Value
Type |
---|
TreeColumnAdvStyleInfo |
DisabledHeaderBackColor
Gets or sets the disabled BackColor of column header.
Declaration
[ThemeStudio]
public Color DisabledHeaderBackColor { get; set; }
Property Value
Type |
---|
System.Drawing.Color |
DisabledTextColor
Gets or sets the color of the disabled column text.
Declaration
[ThemeStudio]
public Color DisabledTextColor { get; set; }
Property Value
Type |
---|
System.Drawing.Color |
Empty
Gets an empty value.
Declaration
public static TreeColumnAdvStyleInfo Empty { get; }
Property Value
Type |
---|
TreeColumnAdvStyleInfo |
Font
Gets or sets the font of the column.
Declaration
public Font Font { get; set; }
Property Value
Type |
---|
System.Drawing.Font |
HasAllowTextOverlap
Gets a value indicating whether an AllowTextOverlap property value has or not.
Declaration
public bool HasAllowTextOverlap { get; }
Property Value
Type |
---|
System.Boolean |
HasAreaBackground
Gets a value indicating whether an AreaBackground property value has or not.
Declaration
public bool HasAreaBackground { get; }
Property Value
Type |
---|
System.Boolean |
HasBackground
Gets a value indicating whether the Background property value has or not.
Declaration
public bool HasBackground { get; }
Property Value
Type |
---|
System.Boolean |
HasBackgroundImage
Gets a value indicating whether the BackgroundImage property value has or not.
Declaration
public bool HasBackgroundImage { get; }
Property Value
Type |
---|
System.Boolean |
HasBaseStyle
Gets a value indicating whether the BaseStyle property value has or not.
Declaration
public bool HasBaseStyle { get; }
Property Value
Type |
---|
System.Boolean |
HasBorder3DStyle
Gets a value indicating whether the Border3DStyle property value has or not.
Declaration
public bool HasBorder3DStyle { get; }
Property Value
Type |
---|
System.Boolean |
HasBorderColor
Gets a value indicating whether the BorderColor property value has or not.
Declaration
public bool HasBorderColor { get; }
Property Value
Type |
---|
System.Boolean |
HasBorderSides
Gets a value indicating whether the BorderSides property value has or not.
Declaration
public bool HasBorderSides { get; }
Property Value
Type |
---|
System.Boolean |
HasBorderSingle
Gets a value indicating whether the BorderSingle property value has or not.
Declaration
public bool HasBorderSingle { get; }
Property Value
Type |
---|
System.Boolean |
HasBorderStyle
Gets a value indicating whether the BorderStyle property value has or not.
Declaration
public bool HasBorderStyle { get; }
Property Value
Type |
---|
System.Boolean |
HasComparer
Gets a value indicating whether the Comparer property value has or not.
Declaration
public bool HasComparer { get; }
Property Value
Type |
---|
System.Boolean |
HasFont
Gets a value indicating whether the Font property value has or not.
Declaration
public bool HasFont { get; }
Property Value
Type |
---|
System.Boolean |
HasHelpText
Gets a value indicating whether the HelpText property value has or not.
Declaration
public bool HasHelpText { get; }
Property Value
Type |
---|
System.Boolean |
HasHighlightBorderColor
Gets a value indicating whether the HighlightBorderColor property value has or not.
Declaration
public bool HasHighlightBorderColor { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
|
HasHorizontalAlignment
Gets a value indicating whether the HorizontalAlignment property value has or not.
Declaration
public bool HasHorizontalAlignment { get; }
Property Value
Type |
---|
System.Boolean |
HasHoverTextColor
Gets a value indicating whether HoverTextColor property value.
Declaration
public bool HasHoverTextColor { get; }
Property Value
Type |
---|
System.Boolean |
HasLeftImage
Gets a value indicating whether the LeftImage property value has or not.
Declaration
public bool HasLeftImage { get; }
Property Value
Type |
---|
System.Boolean |
HasLeftImageIndices
Gets a value indicating whether the LeftImageIndices property value has or not.
Declaration
public bool HasLeftImageIndices { get; }
Property Value
Type |
---|
System.Boolean |
HasLeftImagePadding
Gets a value indicating whether the LeftImagePadding property value has or not.
Declaration
public bool HasLeftImagePadding { get; }
Property Value
Type |
---|
System.Boolean |
HasRightImage
Gets a value indicating whether the RightImage property value has or not.
Declaration
public bool HasRightImage { get; }
Property Value
Type |
---|
System.Boolean |
HasRightImageIndices
Gets a value indicating whether the RightImageIndices property value has or not.
Declaration
public bool HasRightImageIndices { get; }
Property Value
Type |
---|
System.Boolean |
HasRightImagePadding
Gets a value indicating whether the RightImagePadding property value has or not.
Declaration
public bool HasRightImagePadding { get; }
Property Value
Type |
---|
System.Boolean |
HasSortOrder
Gets a value indicating whether the SortOrder property value has or not.
Declaration
public bool HasSortOrder { get; }
Property Value
Type |
---|
System.Boolean |
HasTag
Gets a value indicating whether the Tag property value has or not.
Declaration
public bool HasTag { get; }
Property Value
Type |
---|
System.Boolean |
HasText
Gets a value indicating whether the Text property value has or not.
Declaration
public bool HasText { get; }
Property Value
Type |
---|
System.Boolean |
HasTextColor
Gets a value indicating whether the TextColor property value has or not.
Declaration
public bool HasTextColor { get; }
Property Value
Type |
---|
System.Boolean |
HasVerticalAlignment
Gets a value indicating whether the VerticalAlignment property value has or not.
Declaration
public bool HasVerticalAlignment { get; }
Property Value
Type |
---|
System.Boolean |
HasVisible
Gets a value indicating whether the Visible property value has or not.
Declaration
public bool HasVisible { get; }
Property Value
Type |
---|
System.Boolean |
HasWidth
Gets a value indicating whether the Width property value has or not.
Declaration
public bool HasWidth { get; }
Property Value
Type |
---|
System.Boolean |
HeaderBackColor
Gets or sets the BackColor of column header.
Declaration
[ThemeStudio]
public Color HeaderBackColor { get; set; }
Property Value
Type |
---|
System.Drawing.Color |
HeaderHoverBackColor
Gets or sets the BackColor of column header in Hover state.
Declaration
[ThemeStudio]
public Color HeaderHoverBackColor { get; set; }
Property Value
Type |
---|
System.Drawing.Color |
HelpText
Gets or sets the help text of the column.
Declaration
public string HelpText { get; set; }
Property Value
Type |
---|
System.String |
HighlightBorderColor
Gets or sets the color of the highlight border.
Declaration
public Color HighlightBorderColor { get; set; }
Property Value
Type | Description |
---|---|
System.Drawing.Color | The color of the highlight border. |
HorizontalAlignment
Gets or sets the horizontal text alignment of text.
Declaration
public StringAlignment HorizontalAlignment { get; set; }
Property Value
Type |
---|
System.Drawing.StringAlignment |
HoverTextColor
Gets or sets the color of the column text in hover state.
Declaration
[ThemeStudio]
public Color HoverTextColor { get; set; }
Property Value
Type |
---|
System.Drawing.Color |
LeftImage
Gets or sets the image that will be drawn on the left of the column text.
Declaration
public Image LeftImage { get; set; }
Property Value
Type |
---|
System.Drawing.Image |
LeftImageIndices
Gets or sets the image index to be drawn on the left of the column text.
Declaration
public int[] LeftImageIndices { get; set; }
Property Value
Type |
---|
System.Int32[] |
LeftImagePadding
Gets or sets the padding of left image for the column.
Declaration
public int LeftImagePadding { get; set; }
Property Value
Type |
---|
System.Int32 |
RightImage
Gets or sets image that will be drawn on the right of the column text.
Declaration
public Image RightImage { get; set; }
Property Value
Type |
---|
System.Drawing.Image |
RightImageIndices
Gets or sets the image index to be drawn on the right of the column text.
Declaration
public int[] RightImageIndices { get; set; }
Property Value
Type |
---|
System.Int32[] |
RightImagePadding
Gets or sets the padding of tight image for the column.
Declaration
public int RightImagePadding { get; set; }
Property Value
Type |
---|
System.Int32 |
SortOrder
Gets or sets the sort order of the column.
Declaration
public SortOrder SortOrder { get; set; }
Property Value
Type |
---|
System.Windows.Forms.SortOrder |
SplitterColor
Gets or sets the SplitterColor of column header.
Declaration
[ThemeStudio]
public Color SplitterColor { get; set; }
Property Value
Type |
---|
System.Drawing.Color |
Tag
Gets or sets the tag of the column.
Declaration
public object Tag { get; set; }
Property Value
Type |
---|
System.Object |
Text
Gets or sets the text of the column.
Declaration
public string Text { get; set; }
Property Value
Type |
---|
System.String |
TextColor
Gets or sets the color of the column text.
Declaration
[ThemeStudio]
public Color TextColor { get; set; }
Property Value
Type |
---|
System.Drawing.Color |
VerticalAlignment
Gets or sets the vertical alignment of text.
Declaration
public StringAlignment VerticalAlignment { get; set; }
Property Value
Type |
---|
System.Drawing.StringAlignment |
Visible
Gets or sets a value indicating whether column is visible to user or not.
Declaration
public bool Visible { get; set; }
Property Value
Type |
---|
System.Boolean |
Width
Gets or sets the width value of TreeColumnAdv.
Declaration
public int Width { get; set; }
Property Value
Type |
---|
System.Int32 |
Methods
GetDefaultStyle()
Override this method to return a default style object for your derived class.
Declaration
protected override StyleInfoBase GetDefaultStyle()
Returns
Type | Description |
---|---|
StyleInfoBase | A default style object. |
Overrides
Remarks
You should cache the default style object in a static field.
ResetAllowTextOverlap()
Reset an AllowTextOverlap property value to default value.
Declaration
public void ResetAllowTextOverlap()
ResetAreaBackground()
Reset an AreaBackground property value to default value.
Declaration
public void ResetAreaBackground()
ResetBackground()
Reset the Background property value to default value.
Declaration
public void ResetBackground()
ResetBackgroundImage()
Reset the BackgroundImage property value to default value.
Declaration
public void ResetBackgroundImage()
ResetBaseStyle()
Reset the BaseStyle property value to default value.
Declaration
public void ResetBaseStyle()
ResetBorder3DStyle()
Reset the Border3DStyle property value to default value.
Declaration
public void ResetBorder3DStyle()
ResetBorderColor()
Reset the BorderColor property value to default value.
Declaration
public void ResetBorderColor()
ResetBorderSides()
Reset the BorderSides property value to default value.
Declaration
public void ResetBorderSides()
ResetBorderSingle()
Reset the BorderSingle property value to default value.
Declaration
public void ResetBorderSingle()
ResetBorderStyle()
Reset the BorderStyle property value to default value.
Declaration
public void ResetBorderStyle()
ResetComparer()
Reset the Comparer property value to default value.
Declaration
public void ResetComparer()
ResetFont()
Reset the Font property value to default value.
Declaration
public void ResetFont()
ResetHelpText()
Reset the HelpText property value to default value.
Declaration
public void ResetHelpText()
ResetHighlightBorderColor()
Resets the HighlightBorderColor property to default value.
Declaration
public void ResetHighlightBorderColor()
ResetHorizontalAlignment()
Reset the HorizontalAlignment property value to default value.
Declaration
public void ResetHorizontalAlignment()
ResetLeftImage()
Reset the LeftImage property value to default value.
Declaration
public void ResetLeftImage()
ResetLeftImageIndices()
Reset the LeftImageIndices property value to default value.
Declaration
public void ResetLeftImageIndices()
ResetLeftImagePadding()
Reset the LeftImagePadding property value to default value.
Declaration
public void ResetLeftImagePadding()
ResetRightImage()
Reset the RightImage property value to default value.
Declaration
public void ResetRightImage()
ResetRightImageIndices()
Reset the RightImageIndices property value to default value.
Declaration
public void ResetRightImageIndices()
ResetRightImagePadding()
Reset the RightImagePadding property value to default value.
Declaration
public void ResetRightImagePadding()
ResetSortOrder()
Reset the SortOrder property value to default value.
Declaration
public void ResetSortOrder()
ResetTag()
Reset the Tag property value to default value.
Declaration
public void ResetTag()
ResetText()
Reset the Text property value to default value.
Declaration
public void ResetText()
ResetTextColor()
Reset the TextColor property value to default value.
Declaration
public void ResetTextColor()
ResetVerticalAlignment()
Reset the VerticalAlignment property value to default value.
Declaration
public void ResetVerticalAlignment()
ResetVisible()
Reset the Visible property value to default value.
Declaration
public void ResetVisible()
ResetWidth()
Reset the Width property value to default value.
Declaration
public void ResetWidth()