DataColumn.SetCaption Method (Typed) | |
Set the caption for the data column.
Namespace:
XSharp.VO.SDK
Assembly:
XSharp.VOGUIClasses (in XSharp.VOGUIClasses.dll) Version: 2.21
Syntax VIRTUAL METHOD SetCaption(
cText AS STRING,
kAlignment AS LONG
) AS LOGIC
public virtual bool SetCaption(
string cText,
[DefaultParameterValueAttribute(2, 0)] int kAlignment
)
Request Example
View SourceParameters
- cText
- Type: String
The text to be used as the caption. If omitted, the data browser uses the caption in the hyperlabel. - kAlignment
- Type: Long
One of the following constants representing the alignment of the caption for the data column:
Return Value
Type:
LogicRemarks Constant | Description |
---|
GBAALIGNCENTER | Center aligned |
GBAALIGNLEFT |
Left aligned (This is the default for text.)
|
GBAALIGNRIGHT |
Right aligned (This is the default for numeric data.)
|
Setting a blank caption ("") causes the caption of the data column to be displayed with no caption. Setting a null caption causes the caption to be hidden.
By embedding newline characters in the caption string, the caption field changes height to accommodate multiple lines.
See Also