Hide

SftTree/NET 2.0 - Tree Control for Windows Forms

Display
Print

TextPartClass Class

An instance of the TextPartClass class represents a text part, used to display a single or multiline string.

Cells can contain one or several text parts (instances of the TextPartClass). Each text part can operate independently with its own attributes and properties.

The Action event can be used to handle a mouse clicks on text parts.

If the Action event is used, the ItemClick event is not raised.

Namespace: Softelvdm.Controls
Assembly: Softelvdm.SftTreeNET

Inheritance

Syntax

public class TextPartClass : Softelvdm.Controls.GenericPartClass;
Public Class TextPartClass
    Inherits Softelvdm.Controls.GenericPartClass

Constructors

PublicTextPartClassInitializes a new instance of the TextPartClass class.

Properties

PublicInherited from Softelvdm.Controls.GenericPartClassAngleDefines the rotation of the part.
PublicBackColorDefines the background color of the string.
PublicBackColorSelectedDefines the background color of the part, when the containing item or cell is selected.
PublicFontDefines the font used to render the text part.
PublicForeColorDefines the foreground color of the text part.
PublicForeColorSelectedDefines the foreground color of the part, when the containing item or cell is selected.
PublicFormatDefines display and layout information to render the string.
PublicInherited from Softelvdm.Controls.GenericPartClassHAlignDefines the horizontal alignment within the part's available space.
PublicInherited from Softelvdm.Controls.GenericPartClassOrientationReturns the orientation of parts within a cell. This is defined by the cell or the owner of the cell.
PublicInherited from Softelvdm.Controls.GenericPartClassPartAlignmentDefines the part alignment of this part relative to its container and other parts.
PublicInherited from Softelvdm.Controls.GenericPartClassPartOwnerReturns the owner of the part, usually an object derived from CellBaseClass.
PublicInherited from Softelvdm.Controls.GenericPartClassTagObjectDefines application-specific data.
PublicInherited from Softelvdm.Controls.GenericPartClassTagStringDefines an application-specific string.
PublicTextDefines the string displayed by the part.
PublicTextStyleDefines the text style of the text part.
PublicInherited from Softelvdm.Controls.GenericPartClassVAlignDefines the vertical alignment within the part's available space.
PublicInherited from Softelvdm.Controls.GenericPartClassVisibleAppearanceReturns the visibility status of the part.

Methods

ProtectedInherited from Softelvdm.Controls.GenericPartClassCalcRotatedSizeCalculates the size of the smallest rectangle that can contain the rotated rectangle of a given size, based on the part's GenericPartClass.Angle property.
ProtectedCalcSizeCalculates the size of the part.
ProtectedInherited from Softelvdm.Controls.GenericPartClassCalcUnrotatedBaseWidthCalculates the actual width of the part, based on the width of the rotated part's containing rectangle.
ProtectedConsiderForOutlineDefines whether the part is considered when calculating the outline rectangle of a cell.
ProtectedCopyCreates an identical copy of the part.
ProtectedStaticInherited from Softelvdm.Controls.GenericPartClassCopyPartCopies information from one part to another.
PublicInherited from System.ObjectEqualsDetermines whether the specified object is equal to the current object.
ProtectedInherited from System.ObjectFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
PublicInherited from System.ObjectGetHashCodeServes as the default hash function.
PublicInherited from System.ObjectGetTypeGets the Type of the current instance.
ProtectedInherited from Softelvdm.Controls.GenericPartClassGetVisibleReturns the current visibility status of a part, based on the part's GenericPartClass.VisibleAppearance property.
ProtectedInherited from System.ObjectMemberwiseCloneCreates a shallow copy of the current Object.
ProtectedInherited from Softelvdm.Controls.GenericPartClassOnContentChangedCalled when the contents of the part changed.
PublicStaticInherited from System.ObjectReferenceEqualsDetermines whether the specified Object instances are the same instance.
ProtectedStrategyRoutineUsed to perform various actions the part supports, like rendering the part, hit-testing, determining its position and responding to mouse button clicks.
PublicInherited from System.ObjectToStringReturns a string that represents the current object.

Events

PublicInherited from Softelvdm.Controls.GenericPartClassActionOccurs when a part's action is triggered by the user.

Examples

C#

            sftTree1.Initializing = false;
        }

        private ItemClass AddCategory(string Category) {
            ItemClass item = sftTree1.ItemCollection.Add();
            CellClass cell = item.Cells[0];
            cell.Appearance = BackgroundAppearanceEnum.ThemedSystemHeaderNeverPressed;
            cell.Parts.Add(new ImagePartClass(m_PlusImage));
            cell.Parts.Add(new TextPartClass(Category));
            item.TagString = "This is a tooltip explaining " + Category;
            return item;
        }
        private void AddItem(ItemClass cat, Image img, string ItemText) {
            ItemClass item = cat.Add();
            CellClass cell = item.Cells[0];
            cell.Parts.Add(new ImagePartClass(img));

VB.NET

    sftTree1.Initializing = False
End Sub

Private Function AddCategory(ByVal Category As String) As ItemClass
    Dim item As ItemClass = sftTree1.ItemCollection.Add()
    Dim cell As CellClass = item.Cells(0)
    cell.Appearance = BackgroundAppearanceEnum.ThemedSystemHeaderNeverPressed
    cell.Parts.Add(New ImagePartClass(m_PlusImage))
    cell.Parts.Add(New TextPartClass(Category))
    item.TagString = "This is a tooltip explaining " & Category
    Return item
End Function

Private Sub AddItem(ByVal cat As ItemClass, ByVal img As Image, ByVal ItemText As String)
    Dim item As ItemClass = cat.Add()
    Dim cell As CellClass = item.Cells(0)

See Also Classes | SftTree/NET 2.0