LAnnAutomation::GetTextExpandTokens
#include "ltwrappr.h"
virtual L_INT LAnnAutomation::GetTextExpandTokens(pbTextExpandTokens)
L_BOOL * pbTextExpandTokens; |
/* address of variable to be updated */ |
Gets a value that indicates whether the annotation object's text tokens will expand. This function is available in the Document/Medical Toolkits.
Parameter |
Description |
|
pbTextExpandTokens |
Address of the variable to be updated with the object's text expand token property. Possible values are: |
|
|
Value |
Meaning |
|
TRUE |
Text tokens will be expanded for this object. |
|
FALSE |
Text tokens will not be expanded for this object. |
Returns
SUCCESS |
The function was successful. |
< 1 |
An error occurred. Refer to Return Codes. |
Comments
This function gets a value that indicates whether the text tokens will be expanded for certain annotation objects that display text. The function is valid only for the following annotation objects:
LAnnAutomation
LAnnButton
LAnnNote
LAnnPushPin
LAnnStamp
LAnnText
LAnnTextPointer
If pbTextExpandTokens is updated with TRUE, then all tokens will be expanded.
For example, if you have an LAnnButton object that will expand text tokens, and #D is defined to be the current day of the week (ANNTOKEN_DATE_DAY_OF_WEEK), then entering #D for the text of this button will cause it to display the current day of the week when in design or run mode.
Required DLLs and Libraries
LTANN For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application. |
See Also
Functions: |
|
Topics: |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
//This sample toggles the 'text token expand' property of an annotation
L_VOID SampleAnnTextExpandTokens(LAnnAutomation *pLAutomation)
{
L_BOOL bTextExpandTokens;
L_INT nRet;
L_TCHAR szMsg[200];
nRet = pLAutomation->GetTextExpandTokens(&bTextExpandTokens);
if (nRet == SUCCESS)
{
bTextExpandTokens = !bTextExpandTokens;
wsprintf(szMsg, TEXT("Changing
text expand tokens property to %s"),
bTextExpandTokens ? TEXT("TRUE")
: TEXT("FALSE"));
MessageBox(NULL, szMsg, TEXT(""),
MB_OK);
pLAutomation->SetTextExpandTokens(bTextExpandTokens,
0);
}
else
{
wsprintf(szMsg, TEXT("
LAnnAutomation::GetTextExpandTokens Failed[%d]"), nRet);
MessageBox(NULL, szMsg, TEXT("Error"),
MB_OK);
}
}