Class TreeColumnAdv

Represents a column in a MultiColumnTreeView.

Inheritance

System.Object

System.MarshalByRefObject

TreeColumnAdv

Implements

System.ICloneable

System.IComparable

System.ComponentModel.ISupportInitialize

System.Runtime.Serialization.ISerializable

Inherited Members

System.MarshalByRefObject.CreateObjRef(System.Type)

System.MarshalByRefObject.GetLifetimeService()

System.MarshalByRefObject.InitializeLifetimeService()

System.MarshalByRefObject.MemberwiseClone(System.Boolean)

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Syncfusion.Windows.Forms.Tools.MultiColumnTreeView

Assembly: Syncfusion.Tools.Windows.dll

Syntax

public class TreeColumnAdv : MarshalByRefObject, ICloneable, IComparable, ISupportInitialize, ISerializable

Constructors

TreeColumnAdv()

Initialize a new instance of the TreeColumnAdv class.

Declaration

public TreeColumnAdv()

TreeColumnAdv(SerializationInfo, StreamingContext)

Intialize a new instance of the TreeColumnAdv class.

Declaration

public TreeColumnAdv(SerializationInfo info, StreamingContext context)

Parameters

Type	Name	Description
System.Runtime.Serialization.SerializationInfo	info	Stored all information
System.Runtime.Serialization.StreamingContext	context	It provides the streaming context value.

TreeColumnAdv(String)

Initialize a new instance of the TreeColumnAdv class.

Declaration

public TreeColumnAdv(string text)

Parameters

Type	Name	Description
System.String	text	text of column.

Fields

DefaultHeaderHeigh

TODO: place correct comment here

Declaration

public const int DefaultHeaderHeigh = 22

Field Value

Type
System.Int32

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

Background

Gets or sets the column background style.

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

Remarks

Image will be stretched to column header height.

BaseStyle

Gets or sets the base style for the column from which to inherit.

Declaration

public string BaseStyle { get; set; }

Property Value

Type
System.String

Remarks

The specified base style should be available in the BaseStyles collection.

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 a three dimensional border to the TreeColumnAdv.

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

Bounds

Gets or sets the column bounds.

Declaration

public Rectangle Bounds { get; set; }

Property Value

Type
System.Drawing.Rectangle

CaptionText

Gets or sets a value which holds the caption of column header.

Declaration

public string CaptionText { get; set; }

Property Value

Type
System.String

Remarks

If the property is initialized, then caption of the column is displayed from this property. otherwise it takes a value from TreeColumnAdv.Text property.

ColumnStyle

Gets reference on style that used by column.

Declaration

public TreeColumnAdvStyleInfo ColumnStyle { get; }

Property Value

Type
TreeColumnAdvStyleInfo

Comparer

Gets or sets custom comparer that will be used for column value sorting.

Declaration

public IComparer Comparer { get; set; }

Property Value

Type
System.Collections.IComparer

Font

Gets or sets font that will be used for column text painting.

Declaration

public Font Font { get; set; }

Property Value

Type
System.Drawing.Font

HelpText

Gets or sets hint text for 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.

Highlighted

Gets or sets a value indicating whether column selected state.

Declaration

public bool Highlighted { get; set; }

Property Value

Type
System.Boolean

HorizontalAlignment

Gets or sets the horizontal alignment of the text in column bounds.

Declaration

public StringAlignment HorizontalAlignment { get; set; }

Property Value

Type
System.Drawing.StringAlignment

LeftImage

Gets or sets image that will be painted from left side of the column text.

Declaration

public Image LeftImage { get; set; }

Property Value

Type
System.Drawing.Image

Remarks

Image will be stretched to column header height.

LeftImageIndices

Gets or sets the image index to be drawn on the left of the column's 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 painted from right side of the column text.

Declaration

public Image RightImage { get; set; }

Property Value

Type
System.Drawing.Image

Remarks

Image will be stretched to column header height.

RightImageIndices

Gets or sets the image index to be drawn on the right of the column's text.

Declaration

public int[] RightImageIndices { get; set; }

Property Value

Type
System.Int32[]

RightImagePadding

Gets or sets the padding of tight right image for the column.

Declaration

public int RightImagePadding { get; set; }

Property Value

Type
System.Int32

Size

Gets the column size.

Declaration

public Size Size { get; }

Property Value

Type
System.Drawing.Size

SortOrder

Gets or sets sorting order of the column.

Declaration

public SortOrder SortOrder { get; set; }

Property Value

Type
System.Windows.Forms.SortOrder

Tag

Gets or sets the column user data.

Declaration

public object Tag { get; set; }

Property Value

Type
System.Object

Text

Gets or sets the column text.

Declaration

public string Text { get; set; }

Property Value

Type
System.String

TextColor

Gets or sets the column text color.

Declaration

public Color TextColor { get; set; }

Property Value

Type
System.Drawing.Color

TreeView

Gets the parent control.

Declaration

public MultiColumnTreeView TreeView { get; }

Property Value

Type
MultiColumnTreeView

VerticalAlignment

Gets or sets the vertical alignment of text in column bounds.

Declaration

public StringAlignment VerticalAlignment { get; set; }

Property Value

Type
System.Drawing.StringAlignment

Visible

Gets or sets a value indicating whether column visible to user or not.

Declaration

public bool Visible { get; set; }

Property Value

Type
System.Boolean

Width

Gets or sets column width.

Declaration

public int Width { get; set; }

Property Value

Type
System.Int32

Methods

Clone()

Returns the cloned TreeColumnAdv value.

Declaration

public TreeColumnAdv Clone()

Returns

Type	Description
TreeColumnAdv	Copies all properties.

CompareTo(Object)

Compare the object values.

Declaration

public int CompareTo(object obj)

Parameters

Type	Name	Description
System.Object	obj

Returns

Type
System.Int32

Draw(Graphics, Point)

Draw Column at specified position.

Declaration

public void Draw(Graphics g, Point point)

Parameters

Type	Name	Description
System.Drawing.Graphics	g	Graphics on which we should draw ourself.
System.Drawing.Point	point	X,Y coordinates.

Draw(Graphics, Int32, Int32)

Draw Column at specified position.

Declaration

public void Draw(Graphics g, int x, int y)

Parameters

Type	Name	Description
System.Drawing.Graphics	g	Graphics on which we should draw ourself.
System.Int32	x	X coordinate.
System.Int32	y	Y coordinate.

GetObjectData(SerializationInfo, StreamingContext)

Gets the serialization of TreeColumnAdv objects.

Declaration

public virtual void GetObjectData(SerializationInfo info, StreamingContext context)

Parameters

Type	Name	Description
System.Runtime.Serialization.SerializationInfo	info	Stores all data.
System.Runtime.Serialization.StreamingContext	context	It provides streaming context value.

GetPreferedSize()

Gets the preferred size of TreeColumnAdv.

Declaration

[Obsolete("GetPreferedSize is deprecated, please use GetPreferredSize instead.")]
public Size GetPreferedSize()

Returns

Type
System.Drawing.Size

GetPreferredSize()

Gets the preferred size of TreeColumnAdv.

Declaration

public Size GetPreferredSize()

Returns

Type
System.Drawing.Size

ResetAreaBackground()

Reset property AreaBackground value to default value

Declaration

public virtual void ResetAreaBackground()

ResetBackground()

Reset the Background property value to default value.

Declaration

public virtual void ResetBackground()

ResetBaseStyle()

Reset the BaseStyle property value to default value.

Declaration

public void ResetBaseStyle()

ResetBorder3DStyle()

Reset the Border3DStyle property value to default value.

Declaration

public virtual void ResetBorder3DStyle()

ResetBorderColor()

Reset the BorderColor property value to default value.

Declaration

public virtual void ResetBorderColor()

ResetBorderSides()

Reset the BorderSides property value to default value.

Declaration

public virtual void ResetBorderSides()

ResetBorderSingle()

Reset the BorderSingle property value to default value.

Declaration

public virtual void ResetBorderSingle()

ResetBorderStyle()

Reset the BorderStyle property value to default value.

Declaration

public virtual void ResetBorderStyle()

ResetComparer()

Reset the Comparer property value to default value.

Declaration

public virtual void ResetComparer()

ResetFont()

Reset the Font property value to default value.

Declaration

public virtual void ResetFont()

ResetHelpText()

Reset the HelpText property value to default value.

Declaration

public virtual void ResetHelpText()

ResetHighlightBorderColor()

Reset the HighlightBorderColor property value to default value.

Declaration

public virtual void ResetHighlightBorderColor()

ResetHorizontalAlignment()

Reset the HorizontalAlignment property value to default value.

Declaration

public virtual void ResetHorizontalAlignment()

ResetLeftImage()

Reset the LeftImage property value to default value.

Declaration

public virtual void ResetLeftImage()

ResetLeftImageIndices()

Reset the LeftImageIndices property value to default value.

Declaration

public virtual void ResetLeftImageIndices()

ResetLeftImagePadding()

Reset the LeftImagePadding property value to default value.

Declaration

public virtual void ResetLeftImagePadding()

ResetParent()

Reset column reference on parent.

Declaration

protected virtual void ResetParent()

ResetRightImage()

Reset the RightImage property value to default value.

Declaration

public virtual void ResetRightImage()

ResetRightImageIndices()

Reset the RightImageIndices property value to default value.

Declaration

public virtual void ResetRightImageIndices()

ResetRightImagePadding()

Reset the RightImagePadding property value to default value.

Declaration

public virtual void ResetRightImagePadding()

ResetSortOrder()

Reset the SortOrder property value to default value.

Declaration

public virtual void ResetSortOrder()

ResetTag()

Reset the Tag property value to default value.

Declaration

public virtual void ResetTag()

ResetText()

Reset the Text property value to default value.

Declaration

public virtual void ResetText()

ResetTextColor()

Reset the TextColor property value to default value.

Declaration

public virtual void ResetTextColor()

ResetVerticalAlignment()

Reset the VerticalAlignment property value to default value.

Declaration

public virtual void ResetVerticalAlignment()

ResetVisible()

Reset the Visible property value to default value.

Declaration

public virtual void ResetVisible()

ResetWidth()

Reset the Width property value to default value.

Declaration

public virtual void ResetWidth()

SetParent(MultiColumnTreeView)

Update parent reference of column.

Declaration

protected virtual void SetParent(MultiColumnTreeView tree)

Parameters

Type	Name	Description
MultiColumnTreeView	tree	Reference on parent control.

ShouldSerializeAreaBackground()

Indicate should or not we serialize AreaBackground property value.

Declaration

protected virtual bool ShouldSerializeAreaBackground()

Returns

Type	Description
System.Boolean	True - serialization required, otherwise False.

ShouldSerializeBackground()

Indicate should or not we serialize Background property value.

Declaration

protected virtual bool ShouldSerializeBackground()

Returns

Type	Description
System.Boolean	True - serialization required, otherwise False.

ShouldSerializeBaseStyle()

Declaration

protected bool ShouldSerializeBaseStyle()

Returns

Type
System.Boolean

ShouldSerializeBorder3DStyle()

Indicate should or not we serialize Border3DStyle property value.

Declaration

protected virtual bool ShouldSerializeBorder3DStyle()

Returns

Type	Description
System.Boolean	True - serialization required, otherwise False.

ShouldSerializeBorderColor()

Indicate should or not we serialize BorderColor property value.

Declaration

protected virtual bool ShouldSerializeBorderColor()

Returns

Type	Description
System.Boolean	True - serialization required, otherwise False.

ShouldSerializeBorderSides()

Indicate should or not we serialize BorderSides property value.

Declaration

protected virtual bool ShouldSerializeBorderSides()

Returns

Type	Description
System.Boolean	True - serialization required, otherwise False.

ShouldSerializeBorderSingle()

Indicate should or not we serialize BorderSingle property value.

Declaration

protected virtual bool ShouldSerializeBorderSingle()

Returns

Type	Description
System.Boolean	True - serialization required, otherwise False.

ShouldSerializeBorderStyle()

Indicate should or not we serialize BorderStyle property value.

Declaration

protected virtual bool ShouldSerializeBorderStyle()

Returns

Type	Description
System.Boolean	True - serialization required, otherwise False.

ShouldSerializeComparer()

Indicate should or not we serialize Comparer property value.

Declaration

protected virtual bool ShouldSerializeComparer()

Returns

Type	Description
System.Boolean	True - serialization required, otherwise False.

ShouldSerializeFont()

Indicate should or not we serialize Font property value.

Declaration

protected virtual bool ShouldSerializeFont()

Returns

Type	Description
System.Boolean	True - serialization required, otherwise False.

ShouldSerializeHelpText()

Indicate should or not we serialize HelpText property value.

Declaration

protected virtual bool ShouldSerializeHelpText()

Returns

Type	Description
System.Boolean	True - serialization required, otherwise False.

ShouldSerializeHighlightBorderColor()

Indicate whether to serialize HighlightBorderColor property value.

Declaration

protected virtual bool ShouldSerializeHighlightBorderColor()

Returns

Type	Description
System.Boolean	True - serialization required, otherwise False.

ShouldSerializeHorizontalAlignment()

Indicate should or not we serialize HorizontalAlignment property value.

Declaration

protected virtual bool ShouldSerializeHorizontalAlignment()

Returns

Type	Description
System.Boolean	True - serialization required, otherwise False.

ShouldSerializeLeftImage()

Indicate should or not we serialize LeftImage property value.

Declaration

protected virtual bool ShouldSerializeLeftImage()

Returns

Type	Description
System.Boolean	True - serialization required, otherwise False.

ShouldSerializeLeftImageIndices()

Indicate should or not we serialize LeftImageIndices property value.

Declaration

protected virtual bool ShouldSerializeLeftImageIndices()

Returns

Type	Description
System.Boolean	True - serialization required, otherwise False.

ShouldSerializeLeftImagePadding()

Indicate should or not we serialize LeftImagePadding property value.

Declaration

protected virtual bool ShouldSerializeLeftImagePadding()

Returns

Type	Description
System.Boolean	True - serialization required, otherwise False.

ShouldSerializeRightImage()

Indicate should or not we serialize RightImage property value.

Declaration

protected virtual bool ShouldSerializeRightImage()

Returns

Type	Description
System.Boolean	True - serialization required, otherwise False.

ShouldSerializeRightImageIndices()

Indicate should or not we serialize RightImageIndices property value.

Declaration

protected virtual bool ShouldSerializeRightImageIndices()

Returns

Type	Description
System.Boolean	True - serialization required, otherwise False.

ShouldSerializeRightImagePadding()

Indicate should or not we serialize RightImagePadding property value.

Declaration

protected virtual bool ShouldSerializeRightImagePadding()

Returns

Type	Description
System.Boolean	True - serialization required, otherwise False.

ShouldSerializeSortOrder()

Indicate should or not we serialize SortOrder property value.

Declaration

protected virtual bool ShouldSerializeSortOrder()

Returns

Type	Description
System.Boolean	True - serialization required, otherwise False.

ShouldSerializeTag()

Indicate should or not we serialize Tag property value.

Declaration

protected virtual bool ShouldSerializeTag()

Returns

Type	Description
System.Boolean	True - serialization required, otherwise False.

ShouldSerializeText()

Indicate should or not we serialize Text property value.

Declaration

protected virtual bool ShouldSerializeText()

Returns

Type	Description
System.Boolean	True - serialization required, otherwise False.

ShouldSerializeTextColor()

Indicate should or not we serialize TextColor property value.

Declaration

protected virtual bool ShouldSerializeTextColor()

Returns

Type	Description
System.Boolean	True - serialization required, otherwise False.

ShouldSerializeVerticalAlignment()

Indicate should or not we serialize VerticalAlignment property value.

Declaration

protected virtual bool ShouldSerializeVerticalAlignment()

Returns

Type	Description
System.Boolean	True - serialization required, otherwise False.

ShouldSerializeVisible()

Indicate should or not we serialize Visible property value.

Declaration

protected virtual bool ShouldSerializeVisible()

Returns

Type	Description
System.Boolean	True - serialization required, otherwise False.

ShouldSerializeWidth()

Indicate should or not we serialize Width property value.

Declaration

protected virtual bool ShouldSerializeWidth()

Returns

Type	Description
System.Boolean	True - serialization required, otherwise False.

UpdateColumnLocation(Int32, Int32)

Updates column's location.

Declaration

public void UpdateColumnLocation(int x, int y)

Parameters

Type	Name	Description
System.Int32	x	X position.
System.Int32	y	Y position.

Explicit Interface Implementations

ICloneable.Clone()

Declaration

object ICloneable.Clone()

Returns

Type
System.Object

Implements

System.ICloneable

System.IComparable

System.ComponentModel.ISupportInitialize

System.Runtime.Serialization.ISerializable