GetHeaderPosPix Method, SftTree Object
Returns the coordinates of a column header.
Deprecated - Provided for compatibility with earlier versions only - Use Header.GetPositionPix or Headers.GetPositionPix instead
Syntax
| VB.NET | Boolean = object.GetHeaderPosPix(ByVal ColIndex As Short, ByRef LeftPix As OLE_XPOS_PIXELS, ByRef TopPix As OLE_YPOS_PIXELS, ByRef WidthPix As OLE_XSIZE_PIXELS, ByRef HeightPix As OLE_YSIZE_PIXELS, ByRef Span As Short) As Boolean |
| VB | Boolean = object.GetHeaderPosPix(ByVal ColIndex As Integer, LeftPix As OLE_XPOS_PIXELS, TopPix As OLE_YPOS_PIXELS, WidthPix As OLE_XSIZE_PIXELS, HeightPix As OLE_YSIZE_PIXELS, Span As Integer) As Boolean |
| C#.NET | bool Boolean = object.GetHeaderPosPix(short ColIndex, out OLE_XPOS_PIXELS LeftPix, out OLE_YPOS_PIXELS TopPix, out OLE_XSIZE_PIXELS WidthPix, out OLE_YSIZE_PIXELS HeightPix, out short Span); |
| VC++ | VARIANT_BOOL Boolean = object->GetHeaderPosPix(short ColIndex, OLE_XPOS_PIXELS* LeftPix, OLE_YPOS_PIXELS* TopPix, OLE_XSIZE_PIXELS* WidthPix, OLE_YSIZE_PIXELS* HeightPix, short* Span); |
| C | HRESULT object->raw_GetHeaderPosPix(short ColIndex, OLE_XPOS_PIXELS* LeftPix, OLE_YPOS_PIXELS* TopPix, OLE_XSIZE_PIXELS* WidthPix, OLE_YSIZE_PIXELS* HeightPix, short* Span, VARIANT_BOOL* Boolean); |
object
A SftTree object.
ColIndex
The zero-based column number. If -1 is specified, the dimensions of the combined and all column headers are returned.
LeftPix
Returns the horizontal position relative to the top, left corner of the tree control in pixels.
TopPix
Returns the vertical position relative to the top, left corner of the tree control in pixels.
WidthPix
Returns the width of the column header in pixels.
HeightPix
Returns the height of the column header in pixels.
Span
Returns the number of columns that the column header occupies.
Boolean
| Boolean | Description |
|---|
| True | The column header specified by ColIndex is displayed and visible. |
| False | The column header specified by ColIndex is not visible. The returned coordinates are not valid. |
Comments
Deprecated - Provided for compatibility with earlier versions only - Use Header.GetPositionPix or Headers.GetPositionPix instead
The GetHeaderPosPix method returns the coordinates of a column header.
The GetHeaderPos and GetHeaderPosPix methods are synonyms, but may use different coordinate systems.
To retrieve the coordinates of all combined column headers, use Headers.GetPosition instead.
See Also SftTree Object | Object Hierarchy
On
Off