QG_GetCellCaption

QG_GetCellCaption(areaRef; captionXpression; rectLeft; rectTop; rectRight; rectBottom; displayFormat):errorCode
areaRef Longint QGrid area reference
captionXpression Text The caption expression
rectLeft Longint Left coordinate
rectTop Longint Top coordinate
rectRight Longint Right coordinate
rectBottom Longint Bottom coordinate
displayFormat String255 Caption format description
error Longint Error result

Returns the current caption object setup.

Parameter areaRef is the QGrid area reference. If areaRef is not a valid QGrid area reference, qg_paramErr error is returned. If no picture object was defined, qg_NoPictureErr error is returned.

Parameter captionXpression receives the text expression used to get the caption object.

Parameters rectLeft, rectTop, rectRight and rectBottom receive the caption box coordinates in the cell's coordinate system.

Parameter displayFormat receives the caption text display format.

Example

C_LONGINT($err;$left;$top;$right;$bottom)
C_TEXT($xpression;$format)
 
$err:=QG_GetCellCaption (xGrid;$xpression;$left;$top;$right;$bottom;$format)
 
If ($err = qg_NoCaptionErr)
  ` No caption object was defined for the area
Else
  If ($err # qg_noErr)
    ` Handle the error
  End if
End if
 
 
 

Related commands

QG_SetCellCaption Setup a caption object for the area cells
QG_SetCaptionStyle Sets the caption text appearance
QG_GetCellPicture Return the current picture object

QGrid © Escape
Generated by QDoc 2.8 on Thu, Oct 8, 2009 17:35:57