Class TreeNodeAdvSubItem
Represents a sub item of the TreeNodeAdv in Treeview control.
Inheritance
Implements
Inherited Members
Namespace: Syncfusion.Windows.Forms.Tools.MultiColumnTreeView
Assembly: Syncfusion.Tools.Windows.dll
Syntax
public class TreeNodeAdvSubItem : MarshalByRefObject, ICloneable, IComparable, ISupportInitialize, ISerializable
Constructors
TreeNodeAdvSubItem()
Initialize a new instance of the TreeNodeAdvSubItem class.
Declaration
public TreeNodeAdvSubItem()
TreeNodeAdvSubItem(TreeNodeAdv)
Initializes a new instance of the TreeNodeAdvSubItem class.
Declaration
public TreeNodeAdvSubItem(TreeNodeAdv node)
Parameters
Type | Name | Description |
---|---|---|
TreeNodeAdv | node | Tree node |
TreeNodeAdvSubItem(TreeNodeAdv, String)
Initialize a new instance of the TreeNodeAdvSubItem class.
Declaration
public TreeNodeAdvSubItem(TreeNodeAdv node, string text)
Parameters
Type | Name | Description |
---|---|---|
TreeNodeAdv | node | The Treenode. |
System.String | text | It contains text value as string. |
TreeNodeAdvSubItem(SerializationInfo, StreamingContext)
Initialize a new instance of the TreeNodeAdvSubItem class.
Declaration
public TreeNodeAdvSubItem(SerializationInfo info, StreamingContext context)
Parameters
Type | Name | Description |
---|---|---|
System.Runtime.Serialization.SerializationInfo | info | |
System.Runtime.Serialization.StreamingContext | context |
TreeNodeAdvSubItem(String)
Initialize a new instance of the TreeNodeAdvSubItem class.
Declaration
public TreeNodeAdvSubItem(string text)
Parameters
Type | Name | Description |
---|---|---|
System.String | text | It contains text value as string. |
Properties
Alignment
Gets or sets the text alignment in subitem bounds.
Declaration
public StringAlignment Alignment { get; set; }
Property Value
Type |
---|
System.Drawing.StringAlignment |
Background
Gets or sets the subitem background style.
Declaration
public BrushInfo Background { get; set; }
Property Value
Type |
---|
BrushInfo |
BaseStyle
Gets or sets the base style for the subitem 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 subitem border 3D style.
Declaration
public Border3DStyle Border3DStyle { get; set; }
Property Value
Type |
---|
System.Windows.Forms.Border3DStyle |
BorderColor
Gets or sets the subitem border color.
Declaration
public Color BorderColor { get; set; }
Property Value
Type |
---|
System.Drawing.Color |
BorderSides
Gets or sets the subitem border sides settings.
Declaration
public Border3DSide BorderSides { get; set; }
Property Value
Type |
---|
System.Windows.Forms.Border3DSide |
BorderSingle
Gets or sets the subitem single line border style.
Declaration
public ButtonBorderStyle BorderSingle { get; set; }
Property Value
Type |
---|
System.Windows.Forms.ButtonBorderStyle |
BorderStyle
Gets or sets the subitem border style.
Declaration
public BorderStyle BorderStyle { get; set; }
Property Value
Type |
---|
System.Windows.Forms.BorderStyle |
Font
Gets or sets the subitem text Font.
Declaration
public Font Font { get; set; }
Property Value
Type |
---|
System.Drawing.Font |
HelpText
Gets or sets the subitem help text.
Declaration
public string HelpText { get; set; }
Property Value
Type |
---|
System.String |
LeftImage
Gets or sets the subitem left image.
Declaration
public Image LeftImage { get; set; }
Property Value
Type |
---|
System.Drawing.Image |
LeftImageIndices
Gets or sets the subitem left side indices of images that stored in tree LeftImageList property.
Declaration
public int[] LeftImageIndices { get; set; }
Property Value
Type |
---|
System.Int32[] |
LeftImagePadding
Gets or sets the subitem padding between text and left images.
Declaration
public int LeftImagePadding { get; set; }
Property Value
Type |
---|
System.Int32 |
LineAlignment
Gets or sets the line alignment of the text in subitem.
Declaration
public StringAlignment LineAlignment { get; set; }
Property Value
Type |
---|
System.Drawing.StringAlignment |
RightImage
Gets or sets the subitem image from right side of the text.
Declaration
public Image RightImage { get; set; }
Property Value
Type |
---|
System.Drawing.Image |
RightImageIndices
Gets or sets the subitem right side indices of images that stored in tree RightImageList property.
Declaration
public int[] RightImageIndices { get; set; }
Property Value
Type |
---|
System.Int32[] |
RightImagePadding
Gets or sets padding between text and right side images.
Declaration
public int RightImagePadding { get; set; }
Property Value
Type |
---|
System.Int32 |
SubItemStyle
Gets reference on subitem style.
Declaration
public TreeNodeAdvSubItemStyleInfo SubItemStyle { get; }
Property Value
Type |
---|
TreeNodeAdvSubItemStyleInfo |
Tag
Gets or sets the subitem user data.
Declaration
public object Tag { get; set; }
Property Value
Type |
---|
System.Object |
Text
Gets or sets the subitem text.
Declaration
public string Text { get; set; }
Property Value
Type |
---|
System.String |
Remarks
Subitem that user get by ZERO index represents treenode text and style.
TextColor
Gets or sets the subitem text color.
Declaration
public Color TextColor { get; set; }
Property Value
Type |
---|
System.Drawing.Color |
TreeNode
Gets parent Node.
Declaration
public TreeNodeAdv TreeNode { get; }
Property Value
Type |
---|
TreeNodeAdv |
TreeView
Gets reference on parent control.
Declaration
public MultiColumnTreeView TreeView { get; }
Property Value
Type |
---|
MultiColumnTreeView |
Visible
Gets or sets a value indicating whether visible property has set.
Declaration
public bool Visible { get; set; }
Property Value
Type |
---|
System.Boolean |
Remarks
Visibility of subitem also depends on column Visible property value. If column not visible then all corresponding subitems will be skipped on painting.
Methods
BeginInit()
Signals the object that initialization is starting.
Declaration
public void BeginInit()
Clone()
Returns the cloned TreeNodeAdvSubItem value.
Declaration
public TreeNodeAdvSubItem Clone()
Returns
Type | Description |
---|---|
TreeNodeAdvSubItem | copy of this sub item. |
Draw(Graphics, Int32, Int32, TreeNodeAdv, Rectangle, Int32)
Draws the style for TreeNodeAdvSubItem.
Declaration
public virtual void Draw(Graphics g, int x, int y, TreeNodeAdv mouseDownNode, Rectangle selectionBounds, int width)
Parameters
Type | Name | Description |
---|---|---|
System.Drawing.Graphics | g | The Graphics object. |
System.Int32 | x | The offset value of x. |
System.Int32 | y | The offset value of y. |
TreeNodeAdv | mouseDownNode | The node value. |
System.Drawing.Rectangle | selectionBounds | The boundselection. |
System.Int32 | width | TreeNodeAdvSubItem's column width |
EndInit()
Signals the object that initialization is complete.
Declaration
public void EndInit()
GetForeColor(Boolean)
Declaration
protected Color GetForeColor(bool selected)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | selected |
Returns
Type |
---|
System.Drawing.Color |
GetObjectData(SerializationInfo, StreamingContext)
Gets the serialization of TreeNodeAdvSubItem objects.
Declaration
public void GetObjectData(SerializationInfo info, StreamingContext context)
Parameters
Type | Name | Description |
---|---|---|
System.Runtime.Serialization.SerializationInfo | info | Serialization Info |
System.Runtime.Serialization.StreamingContext | context | Streaming Context |
ResetAlignment()
Reset Alignment property value to default value.
Declaration
public virtual void ResetAlignment()
ResetBackground()
Reset Background property value to default value.
Declaration
public virtual void ResetBackground()
ResetBaseStyle()
Reset BaseStyle property value to default value.
Declaration
public virtual void ResetBaseStyle()
ResetBorder3DStyle()
Reset Border3DStyle property value to default value.
Declaration
public virtual void ResetBorder3DStyle()
ResetBorderColor()
Reset BorderColor property value to default value.
Declaration
public virtual void ResetBorderColor()
ResetBorderSides()
Reset BorderSides property value to default value.
Declaration
public virtual void ResetBorderSides()
ResetBorderSingle()
Reset BorderSingle property value to default value.
Declaration
public virtual void ResetBorderSingle()
ResetBorderStyle()
Reset BorderStyle property value to default value.
Declaration
public virtual void ResetBorderStyle()
ResetFont()
Reset Font property value to default value.
Declaration
public virtual void ResetFont()
ResetHelpText()
Reset HelpText property value to default value.
Declaration
public virtual void ResetHelpText()
ResetLeftImage()
Reset LeftImage property value to default value.
Declaration
public virtual void ResetLeftImage()
ResetLeftImageIndices()
Reset LeftImageIndices property value to default value.
Declaration
public virtual void ResetLeftImageIndices()
ResetLeftImagePadding()
Reset property LeftImagePadding value to default value
Declaration
public virtual void ResetLeftImagePadding()
ResetLineAlignment()
Reset LineAlignment property value to default value.
Declaration
public virtual void ResetLineAlignment()
ResetParent()
Declaration
protected virtual void ResetParent()
ResetRightImage()
Reset RightImage property value to default value.
Declaration
public virtual void ResetRightImage()
ResetRightImageIndices()
Reset RightImageIndices property value to default value.
Declaration
public virtual void ResetRightImageIndices()
ResetRightImagePadding()
Reset RightImagePadding property value to default value.
Declaration
public virtual void ResetRightImagePadding()
ResetTag()
Reset Tag property value to default value.
Declaration
public virtual void ResetTag()
ResetText()
Reset Text property value to default value.
Declaration
public virtual void ResetText()
ResetTextColor()
Reset TextColor property value to default value.
Declaration
public virtual void ResetTextColor()
ResetVisible()
Reset Visible property value to default value.
Declaration
public virtual void ResetVisible()
SetParent(TreeNodeAdv)
Declaration
protected virtual void SetParent(TreeNodeAdv node)
Parameters
Type | Name | Description |
---|---|---|
TreeNodeAdv | node |
ShouldSerializeAlignment()
Indicate should or not we serialize Alignment property value.
Declaration
protected virtual bool ShouldSerializeAlignment()
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()
Indicate should or not we serialize BaseStyle property value.
Declaration
protected virtual bool ShouldSerializeBaseStyle()
Returns
Type | Description |
---|---|
System.Boolean | True - serialization required, otherwise False. |
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. |
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. |
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. |
ShouldSerializeLineAlignment()
Indicate should or not we serialize LineAlignment property value.
Declaration
protected virtual bool ShouldSerializeLineAlignment()
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. |
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. |
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. |
ToString()
Overrides the ToString() method.
Declaration
public override string ToString()
Returns
Type | Description |
---|---|
System.String | Returns the text. |
Overrides
Explicit Interface Implementations
ICloneable.Clone()
Clone TreeNodeAdv sub-item
Declaration
object ICloneable.Clone()
Returns
Type | Description |
---|---|
System.Object | copy of this sub item. |
IComparable.CompareTo(Object)
Declaration
int IComparable.CompareTo(object obj)
Parameters
Type | Name | Description |
---|---|---|
System.Object | obj |
Returns
Type |
---|
System.Int32 |