L_AnnSetTextOptions (original) (raw)

Summary

Sets the text options for the annotation object.

Syntax

#include "l_bitmap.h"

L_LTANN_API L_INT L_AnnSetTextOptions (hObject, pTextOptions, uFlags);

Parameters

HANNOBJECT hObject

Handle to the annotation object.

pANNTEXTOPTIONS pTextOptions

Pointer to an ANNTEXTOPTIONS structure that specifies the text options to set.

L_UINT uFlags

Flags that determine which objects to process. Most of the flags apply only to container objects. You can combine values when appropriate by using a bitwise OR ( | ). The following are valid values:

Returns

Comments

Use this function to set the text options of any annotation object that uses text. To use this function, declare a variable of type ANNTEXTOPTIONS, and pass the address of this variable for pTextOptions. For more information, refer to the documentation for the structure ANNTEXTOPTIONS.

The hObject parameter must be one of the following types:

• ANNOBJECT_CONTAINER
• ANNOBJECT_AUTOMATION
• ANNOBJECT_TEXT
• ANNOBJECT_TEXTPOINTER
• ANNOBJECT_STAMP
• ANNOBJECT_NOTE
• ANNOBJECT_PUSHPIN
• ANNOBJECT_BUTTON

Otherwise ERROR_FEATURE_NOT_SUPPORTED is returned.

Note: You must first enable this function by calling L_AnnSetOptions with the OPTIONS_NEW_TEXT_OPTIONS flag.

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.

Platforms

Win32, x64.

See Also

Functions

• L_AnnGetTextOptions
• L_AnnSetText
• L_AnnGetText
• L_AnnGetTextLen
• L_AnnSetTextAlign
• L_AnnGetTextAlign
• L_AnnSetTextRotate
• L_AnnGetTextRotate
• L_AnnSetOptions
• L_AnnGetOptions
• L_AnnGetTextFixedSize
• L_AnnSetTextFixedSize

Topics

• Annotation Features
• Annotation Functions (Document/Medical only): Getting and Setting Text Properties
• Altering Annotation Object Settings
• User Interface for Container and Automation Objects
• Displaying and Manipulating Annotation Objects
• Obtaining Annotation Object Information
• Container Annotation Object
• Annotation Automation Object
• Text Annotation Object
• Text Pointer Annotation Object
• Stamp Annotation Object
• Note Annotation Object
• PushPin Annotation Object
• Button Annotation Object

Example

The following example changes some of the text options of a text-based annotation. It changes the text color to blue, and toggles the ShowBorder option.

L_INT AnnSetTextOptionsExample(HANNOBJECT hObject) { L_INT nRet = SUCCESS; ANNTEXTOPTIONS TextOptions; L_UINT uOptions = 0; L_TCHAR szMsg[200]; nRet = L_AnnGetOptions(&uOptions); if(nRet != SUCCESS) return nRet; uOptions |= OPTIONS_NEW_TEXT_OPTIONS; nRet = L_AnnSetOptions(NULL, uOptions); if (nRet != SUCCESS) return nRet; memset(&TextOptions, 0, sizeof(ANNTEXTOPTIONS)); TextOptions.uStructSize = sizeof(ANNTEXTOPTIONS); TextOptions.uFlags = ANNTEXT_SHOW_TEXT | ANNTEXT_SHOW_BORDER | ANNTEXT_TEXTCOLOR; nRet = L_AnnGetTextOptions(hObject, &TextOptions, sizeof(ANNTEXTOPTIONS)); if (nRet != SUCCESS) return nRet; wsprintf(szMsg, TEXT("Old Options: ShowText[%d], ShowBorder[%d], TextColor[0x%x]"), TextOptions.bShowText, TextOptions.bShowBorder, TextOptions.crText); _tprintf(_T("%s"), szMsg); // Change some options TextOptions.bShowBorder = !TextOptions.bShowBorder; TextOptions.crText = RGB(0,0,255); TextOptions.uFlags = ANNTEXT_SHOW_BORDER | ANNTEXT_TEXTCOLOR; nRet = L_AnnSetTextOptions(hObject, &TextOptions, 0); if (nRet != SUCCESS) return nRet; memset(&TextOptions, 0, sizeof(ANNTEXTOPTIONS)); TextOptions.uStructSize = sizeof(ANNTEXTOPTIONS); TextOptions.uFlags = ANNTEXT_SHOW_TEXT | ANNTEXT_SHOW_BORDER | ANNTEXT_TEXTCOLOR; nRet = L_AnnGetTextOptions(hObject, &TextOptions, sizeof(ANNTEXTOPTIONS)); if (nRet != SUCCESS) return nRet; wsprintf(szMsg, TEXT("New Options: ShowText[%d], ShowBorder[%d], TextColor[0x%x]"), TextOptions.bShowText, TextOptions.bShowBorder, TextOptions.crText); _tprintf(_T("%s"), szMsg); return SUCCESS; }