DataColumn.SetCaption Method | |
Set the caption for the data column.
Namespace:
VO
Assembly:
VOGUIClasses (in VOGUIClasses.dll) Version: 2.21
Syntax VIRTUAL METHOD SetCaption(
cText,
kAlignment
) AS USUAL CLIPPER
[ClipperCallingConventionAttribute(new string[] { ... })]
public virtual Usual SetCaption(
Usual cText = default,
Usual kAlignment = default
)
Request Example
View SourceParameters
- cText (Optional)
- Type: Usual
The text to be used as the caption. If omitted, the data browser uses the caption in the hyperlabel. - kAlignment (Optional)
- Type: Usual
One of the following constants representing the alignment of the caption for the data column:
Return Value
Type:
UsualRemarks 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