SftTree/NET 2.0 Documentation

Display
Print

Softelvdm.SftTreeNET Classes

All classes shown in this table are part of the SftTree/NET control. These classes and objects are used to access properties and methods exposed by each. An instance of the SftTree class represents the SftTree/NET control. Through its properties, additional objects can be accessed.

ClassDescription
ActionEventArgsProvides data for the Action event.
ButtonPartClassAn instance of the ButtonPartClass class represents a button part.
ButtonsClassAn instance of the ButtonsClass class describes attributes that apply to all expand/collapse buttons in a SftTree/NET control.
CellBaseClassThe CellBaseClass abstract class is the base class for all cells in controls published by Softel vdm, Inc.
CellClassAn instance of the CellClass class describes one individual cell in a SftTree/NET control.
CellCollectionClassAn instance of the CellCollectionClass class represents all cells managed by one item.
CheckBoxPartClassAn instance of the CheckBoxPartClass class represents a checkbox part.
ColumnClassAn instance of the ColumnClass class represents one individual column in a SftTree/NET control.
ColumnCollectionClassAn instance of the ColumnCollectionClass class represents a collection of all defined columns in a SftTree/NET control.
ColumnReorderedEventArgsProvides data for the ColumnReordered event.
ColumnResizedEventArgsProvides data for the ColumnResized event.
ColumnsClassAn instance of the ColumnsClass class describes attributes that apply to all columns in a SftTree/NET control.
ContentsClassAn instance of the ContentsClass class is used to serialize the contents of the tree control.
DimensionsClassAn instance of the DimensionsClass class describes various dimensions, object sizes, distances in a SftTree/NET control.
DragDetectedEventArgsProvides data for the DragDetected event.
DropDownButtonPartClassAn instance of the DropDownButtonPartClass class represents a dropdown button part.
EditAllowedEventArgsProvides data for the EditAllowed event.
EditClickOutsideEventArgsProvides data for the EditClickOutside event.
EditEndedEventArgsProvides data for the EditEnded event.
EditSetupEventArgsProvides data for the EditSetup event.
EditValidateEventArgsProvides data for the EditValidate event.
FooterClickedEventArgsProvides data for the FooterClicked event.
FootersClassAn instance of the FootersClass class describes attributes that apply to all footers in a SftTree/NET control.
GadgetsClassAn instance of the GadgetsClass class describes basic attributes of parts used in cells, such as checkboxes, buttons, etc.
GapPartClassAn instance of the GapPartClass class represents a gap part.
GenericPartClassAn instance of the GenericPartClass abstract class represents one part in the parts collection of a cell.
HeaderClickedEventArgsProvides data for the HeaderClicked event.
HeadersClassAn instance of the HeadersClass class describes attributes that apply to all headers in a SftTree/NET control.
HorizontalOffsetChangedEventArgsProvides data for the SftTree.HorizontalOffsetChanged event.
ImagePartClassAn instance of the ImagePartClass class represents an image part.
ItemClassAn instance of the ItemClass class describes one individual item in a SftTree/NET control.
ItemClickEventArgsProvides data for the ItemClick event and ItemDoubleClick event.
ItemCollapsedEventArgsProvides data for the ItemCollapsed event.
ItemCollectionClassAn instance of the ItemCollectionClass class represents an item collection.
ItemExpandedEventArgsProvides data for the ItemExpanded event.
ItemRemovedEventArgsProvides data for the ItemRemoved event.
LeftPaneAn instance of the LeftPane class represents the left pane in a SftTree/NET control.
PartEventArgsProvides data for the CheckBoxClicked event and RadioButtonClicked event.
PartsCollectionClassAn instance of the PartsCollectionClass class describes a group of parts in one individual cell.
PartsRenderingClassAn instance of the PartsRenderingClass class represents an object used to render parts.
ProgressBarPartClassAn instance of the ProgressBarPartClass class represents a progressbar part.
RadioButtonPartClassAn instance of the RadioButtonPartClass class represents a radiobutton part.
RightPaneAn instance of the RightPane class represents the right pane in a SftTree/NET control.
RowHeaderClassAn instance of the RowHeaderClass class describes one individual row header in a SftTree/NET control.
RowHeadersClassAn instance of the RowHeadersClass class defines attributes for all row headers in a SftTree/NET control.
SftTreeThe SftTree class represents the SftTree/NET control, a multi-column tree control for Windows Forms.
SoftelvdmUserControlThe SoftelvdmUserControl abstract class represents a generic control. Controls published by Softel vdm, Inc. inherit base functionality from this class.
SortAscendingDefault implementation of an IComparer interface used with the ItemCollectionClass.Sort method to sort items in an ascending fashion, based on the cell text in a specified column.
SortDescendingDefault implementation of an IComparer interface used with the ItemCollectionClass.Sort method to sort items in an descending fashion, based on the cell text in a specified column.
SplitterClassAn instance of the SplitterClass class represents the splitter bar in a SftTree/NET control and its attributes.
StrategyClassAn instance of the StrategyClass class is used with the StrategyRoutine to provide information about the requested action.
TextPartClassAn instance of the TextPartClass class represents a text part, used to display a single or multiline string.
ToolTipClassAn instance of the ToolTipClass class defines tooltip attributes of a control.
ToolTipEventArgsProvides data for the ShowToolTip event.
EnumerationDescription
ArrowLocationEnumDefines the location of the stem of a balloon style tooltip (ToolTipAppearanceEnum.Balloon).
AutoExpandAreaEnumUsed with the SftTree.AutoExpandArea property to define when items are expanded automatically (see SftTree.AutoExpandHover and SftTree.AutoExpandDragDrop).
BackgroundAppearanceEnumDefines the background appearance.
BoolOptionalEnumDefines an extended boolean value.
ButtonBehaviorEnumDefines the behavior of a button.
ButtonLookEnumDefines the appearance of expand/collapse buttons.
CalcSizeEnumDefines the method used to calculate the part's size.
CharSearchModeEnumUsed with the SftTree.CharSearchMode property to define the search mode for characters typed by the user.
CheckBoxStateEnumDefines the state of a checkbox.
CollapseStyleEnumUsed with the Collapse method.
CopyStyleEnumUsed with the ItemClass.Copy method to define how the item is copied.
DragStyleEnumUsed with the SftTree.DragStyle property defining drag detection.
EditNavigateEnumDefines the direction when using the SftTree.EditNavigate method.
ExpandCollapseButtonStyleEnumUsed with the ItemClass.ExpandCollapseButton property to define the expand/collapse button style.
ExpandStyleEnumUsed with the Expand method.
GadgetAppearanceEnumDefines the basic appearance of a gadget.
GadgetUsageEnumDefines the basic usage of a gadget.
GridLinesOptStyleEnumDefines the grid lines style.
GridLinesStyleEnumDefines the grid lines style.
HAlignmentEnumDefines the horizontal alignment.
HAlignmentOptionalEnumDefines the horizontal alignment.
HierarchyColorStyleEnumUsed with the SftTree.HierarchyColorStyle property defining how the background of the hierarchy area in the hierarchy column is rendered.
ItemClickAreaEnumDefines the area where a mouse click occurred.
LinesPenStyleEnumDefines the pen style for a line.
LineStyleEnumDefines attributes of a text string.
MergeStyleEnumDefines the merge style used by cells.
MoveStyleEnumUsed with the ItemClass.Move method to define how the item is moved.
OrientationEnumDefines the cell parts orientation.
OrientationOptionalEnumDefines the cell parts orientation.
PaneEnumDescribes the pane.
PartAlignmentEnumDefines the alignment of the part within a cell (derived from CellBaseClass).
PersistContentsEnumDefines processing options when saving/loading contents using the SftTree.GetContents and SftTree.SetContents methods.
PositionEnumDefines the position of the tooltip, relative to the data it references.
RadioButtonStateEnumDefines the state of a radiobutton.
ScrollStyleEnumDefines the display of a scroll bar.
SelectableAreaEnumDefines which areas of items or cells can be clicked by an end user to select the item or cell.
SelectionHighlightStyleEnumDefines the appearance of selected (or highlighted) cells and items.
SelectionOutlineStyleEnumDefines the appearance of the selection highlight.
SelectionStyleEnumUsed with the SftTree.SelectionStyle property defining whether items or cells are selectable within the item area.
ShowExpandCollapseButtonsEnumUsed with the SftTree.ShowExpandCollapseButtons property to define whether expand/collapse buttons are shown.
SortIndicatorPositionEnumDefines the position of sorting indicators.
SortStatusEnumDefines the sorting indicator status.
StrategyReasonEnumDefines the current operation requested.
ToolTipAppearanceEnumDefines the appearance of the tooltip.
TreeLineStyleEnumUsed with the SftTree.TreeLineStyle property to define whether tree lines are displayed.
UsageLocationEnumUsed to define in which area of the control the cell or item is used.
VAlignmentEnumDefines the vertical alignment.
VAlignmentOptionalEnumDefines the vertical alignment.
VisibleAppearanceEnumDefines the visual appearance of a part.
DelegateDescription
ActionEventHandlerRepresents the method that will handle the Action event of a part.
CheckBoxEventHandlerRepresents the method that will handle the CheckBoxClicked event.
ColumnReorderedEventHandlerRepresents the method that will handle the ColumnReordered event.
ColumnResizedEventHandlerRepresents the method that will handle the ColumnResized event.
DragDetectedEventHandlerRepresents the method that will handle the DragDetected event.
EditAllowedEventHandlerRepresents the method that will handle the EditAllowed event.
EditClickOutsideEventHandlerRepresents the method that will handle the EditClickOutside event.
EditEndedEventHandlerRepresents the method that will handle the EditEnded event.
EditSetupEventHandlerRepresents the method that will handle the EditSetup event.
EditValidateEventHandlerRepresents the method that will handle the EditValidate event.
FocusObjectChangedEventHandlerRepresents the method that will handle the FocusObjectChanged event.
FooterClickedEventHandlerRepresents the method that will handle the FooterClicked event.
FooterDoubleClickedEventHandlerRepresents the method that will handle the FooterDoubleClicked event.
FooterHeightChangedEventHandlerRepresents the method that will handle the FooterHeightChanged event.
HeaderClickedEventHandlerRepresents the method that will handle the HeaderClicked event.
HeaderDoubleClickedEventHandlerRepresents the method that will handle the HeaderDoubleClicked event.
HeaderHeightChangedEventHandlerRepresents the method that will handle the HeaderHeightChanged event.
HorizontalOffsetChangedEventHandlerRepresents the method that will handle the HorizontalOffsetChanged event.
ItemClickEventHandlerRepresents the method that will handle the ItemClick event.
ItemCollapsedEventHandlerRepresents the method that will handle the ItemCollapsed event.
ItemDoubleClickEventHandlerRepresents the method that will handle the ItemDoubleClick event.
ItemExpandedEventHandlerRepresents the method that will handle the ItemExpanded event.
ItemReleasedEventHandlerRepresents the method that will handle the ItemReleased event.
ItemRemovedEventHandlerRepresents the method that will handle the ItemRemoved event.
RadioButtonEventHandlerRepresents the method that will handle the RadioButtonClicked event.
SelectionChangedEventHandlerRepresents the method that will handle the SelectionChanged event.
ShowScrollTipEventHandlerRepresents the method that will handle the ShowScrollTip event.
ShowToolTipEventHandlerRepresents the method that will handle the ShowToolTip event.
SplitterOffsetChangedEventHandlerRepresents the method that will handle the SplitterOffsetChanged event.
TopItemChangedEventHandlerRepresents the method that will handle the TopItemChanged event.

See Also SftTree/NET 2.0