SftTree/NET 2.0

HeadersClass Class

Softel vdm, Inc.

  HeadersClass Class (Softelvdm.SftTreeNET Namespace)

An instance of the HeadersClass class describes attributes that apply to all headers in a SftTree/NET control.

There is only one instance of the HeadersClass class for one SftTree/NET control. It is accessed using the control's Headers property.

VB   

Public Class HeadersClass Inherits Object

C#   

public class HeadersClass : Object

C++   

public ref class HeadersClass : public Object


Public

Constructors

Properties

Fields

Methods

Events

Protected

Constructors

Properties

Fields

Methods

 


Public Constructors

Description

none

This class cannot be instantiated.

   

Public Properties

Description

public propertyAllowMergeFromPreviousDefault

Defines the default value for the CellBaseClass.AllowMergeFromPrevious property for cells in column headers, whether cells allow merging with cells in the previous column.

public propertyAllowMergeFromUpperDefault

Defines the default value for the CellBaseClass.AllowMergeFromUpper property for cells in column headers, whether cells are eligible to be used for cell merging by cells above.

public propertyAppearanceDefault

Defines the default background appearance of all column headers.

public propertyBackColor

Defines the default background color for all column headers that are not selected.

public propertyBackColorSelected

Defines the default background color for all column headers that are selected.

public propertyBehavior

Defines the behavior of the cells in the header area when clicked.

public propertyButtonDarkColor

Defines the color used to draw the slightly dark edge of a column header button (BackgroundAppearanceEnum.ButtonPlain and BackgroundAppearanceEnum.HeaderEmptyArea only).

public propertyButtonDarkDarkColor

Defines the color used to draw the dark edge of a column header button (BackgroundAppearanceEnum.ButtonPlain only).

public propertyButtonFaceColor

Defines the color used to draw the face of a column header button (BackgroundAppearanceEnum.ButtonPlain only).

public propertyButtonLightColor

Defines the color used to draw the lighted edge of a column header button (BackgroundAppearanceEnum.ButtonPlain only).

public propertyButtonLightLightColor

Defines the color used to draw the highlighted edge of a column header button (BackgroundAppearanceEnum.ButtonPlain only).

public propertyClickedColumn

Returns the column index of the cell in the column header area that was last pressed.

public propertyClickedRow

Returns the row index of the cell in the column header area that was last pressed.

public propertyFlybyHighlight

Defines whether column headers are highlighted as the mouse cursor moves over a column header.

public propertyFlybyHighlightUnderline

Defines whether column headers are underlined as the mouse cursor moves over a column header.

public propertyFont

Defines the default font for column headers.

public propertyForeColor

Defines the default foreground color for all column headers that are not selected.

public propertyForeColorSelected

Defines the default foreground color for all column headers that are selected.

public propertyGapBetweenParts

Defines the gap between parts within one cell in the column header area.

public propertyGrayText

Defines the foreground color for all column headers that are disabled.

public propertyHAlignDefault

Defines the default horizontal alignment for parts within cells in column headers.

public propertyHeight

Returns the height of the header area.

public propertyItem

Returns the cell with the specified zero-based row index and zero-based column index.

public propertyLastClicked

Returns the cell in the column header area that was last pressed.

public propertyLinearGradientMode

Defines the linear gradient mode used to render the available background area in cells in the column header area.

public propertyMaxLines

Defines the maximum number of text lines to be displayed by column headers.

public propertyMergeWithLowerDefault

Defines the default value for the CellBaseClass.MergeWithLower property for cells in column headers, whether cells are eligible to merge with cells below, in the same column.

public propertyMergeWithNextDefault

Defines the default value for the CellBaseClass.MergeWithNext property for cells in column headers, whether cells are eligible to merge with the next adjacent cell.

public propertyOrientationDefault

Defines the default orientation of the parts within cells in column headers.

public propertyPartsBottomEdge

Defines the bottom edge gap for cells in the column header area, used to calculate the available interior space in a cell (GenericPartClass.PartAlignment).

public propertyPartsLeftEdge

Defines the left edge gap for cells in the column header area, used to calculate the available interior space in a cell (GenericPartClass.PartAlignment).

public propertyPartsRightEdge

Defines the right edge gap for cells in the column header area, used to calculate the available interior space in a cell (GenericPartClass.PartAlignment).

public propertyPartsTopEdge

Defines the top edge gap for cells in the column header area, used to calculate the available interior space in a cell (GenericPartClass.PartAlignment).

public propertyPressed

Returns the cell in the column header area that is currently pressed.

public propertyReorderable

Defines whether columns are reorderable using column headers.

public propertyResizable

Defines whether columns are resizable using column headers.

public propertyRowHeaders

Returns the array of row headers available in the header area.

public propertyRows

Defines the number of rows in the header area.

public propertyShowToolTips

Defines whether tooltips are shown for column headers.

public propertySize

Returns the size of the header area.

public propertySortIndicatorPositionDefault

Defines the default sorting indicator position for column headers.

public propertyVAlignDefault

Defines the default vertical alignment for parts within cells in column headers.

public propertyVisible

Defines whether column headers and the header area are visible.

  

Public Methods

Description

public methodCellFromPoint

Determines the cell given a point in the column header area.

public methodEqualsinherited from System.Object

Determines whether the specified Object is equal to the current Object.

public methodGetHashCodeinherited from System.Object

Serves as a hash function for a particular type. GetHashCode is suitable for use in hashing algorithms and data structures like a hash table.

public methodGetTypeinherited from System.Object

Gets the Type of the current instance.

public methodMoveDown

Moves the specified column header row down by one row.

public methodMoveUp

Moves the specified column header row up by one row.

public methodstatic / sharedReferenceEqualsinherited from System.Object

Determines whether the specified Object instances are the same instance.

public methodRemoveAt

Removes the row at the specified index.

public methodSetSortStatus

Sets the sorting indicator of all header cells to the specified value.

public methodToStringinherited from System.Object

Returns a String that represents the current Object.

  

Public Event

Description

public eventPropertyChanged

Occurs when a property of a HeadersClass instance is modified.

  

Protected Methods

Description

protected methodFinalizeinherited from System.Object

Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.

protected methodMemberwiseCloneinherited from System.Object

Creates a shallow copy of the current Object.

  

See Also     Softelvdm.SftTreeNET Namespace


Feedback / comments / error reports for this topic
© 2007 - Softel vdm, Inc. - www.softelvdm.com