LAnnNote::SetText

#include "ltwrappr.h"

virtual L_INT LAnnNote::SetText(pText, uFlags=0)

L_TCHAR * pText;

character string to assign

L_UINT uFlags;

flags that indicate the object to process

Sets the text (character string) of the annotation object.

Parameter Description
pText The character string to assign to the annotation object.
uFlags Flags that indicate the object to process. You can combine values when appropriate by using a bitwise OR ( | ). The following are valid values:
  Value Meaning
  0 Process only the specified object.
  ANNFLAG_SELECTED [0x0001] Process only objects that have the selected property set to TRUE. For getting and setting the selected property, use the LAnnotation::IsSelected and LAnnotation::SetSelected functions.
  ANNFLAG_NOINVALIDATE [0x0010] Do not invalidate the affected rectangle in the window. Use this to avoid generating unwanted paint messages.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

The LAnnNote class gets and sets text without formatting. Use the LAnnRTF class to use formatted text.

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:

Class Members

Topics:

Annotation Functions: Object Properties

Example

For an example, refer to LAnnNote::GetText.

Help Version 20.0.2019.3.12
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2019 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Raster Imaging C++ Class Library Help