Collapse All Expand All

LAnnotation::GetShowStampBorder

#include "ltwrappr.h"

L_INT LAnnotation::GetShowStampBorder(pbShowStampBorder)

L_BOOL * pbShowStampBorder;

/* address of the variable to be updated */

Gets a value indicating whether the bitmap stamp is displayed with a border.

Parameter	Description
pbShowStampBorder	Address of the variable to be updated with a value indicating whether the stamp object is displayed with a border. Possible values are:
	Value	Meaning
	TRUE	Show the border.
	FALSE	Do not show the border.

Returns

SUCCESS	The function was successful.
< 1	An error occurred. Refer to Return Codes.

Comments

Gets a value indicating whether the annotation stamp object (ANNOBJECT_STAMP) is displayed with a border. The LAnnotation::GetShowStampBorder function is valid only for the following object types when they are using a bitmap or a metafile:

Stamp (including the Rubber Stamp tools)

In addition, the Automation object stores this setting along with the other object default settings.

Call the LAnnotation::GetForeColor function to get the border color. Call the LAnnotation::GetLineWidth function to get the border width. By default the border width is .075 points.

Call the LAnnotation::SetShowStampBorder function to set such objects to display a border. By default the border color is red (0x00FF0000).

Note that the ANNOBJECT_STAMP can display text, a bitmap, or a metafile. If the stamp contains a bitmap or a metafile, use LAnnotation::SetShowStampBorder to show or hide the border. If the stamp contains text, use LAnnotation::SetText to show or hide the border.

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:	LAnnotation::SetShowStampBorder, LAnnotation::GetTextOptions, LAnnotation::SetTextOptions, LAnnotation::GetForeColor
Topics:	Implementing Annotations
	Altering Annotation Object Settings
	Displaying and Manipulating Annotation Objects
	Obtaining Annotation Object Information
	Container Annotation Object
	Annotation Automation Object

Example

For an example, refer to LAnnotation::SetShowStampBorder.