In This Topic ▼

LAnnNote::SetFontSize

✎ NOTE

THIS FUNCTION IS NOW INHERITED DIRECTLY FROM THE PARENT LANNOTATION CLASS.

Summary

Sets the font size of the annotation object.

Syntax

#include "ltwrappr.h"

virtual L_INT LAnnNote::SetFontSize(dFontSize, uFlags=0)

Parameters

L_DOUBLE dFontSize

The font size to set, expressed as an unscaled value relative to the container.

L_UINT 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

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

Comments

The font size of an object is relative to its container object. The height of a font is interpreted using the container's vertical scaling factor. For example, suppose you want the font to appear as a 10-point font on your screen using the current scaling factor. You would use the following calculation, where A is the pixel height of a 10-point font, B is the value that you get from the LAnnotation::GetScalarX function, and C is the value that you get from the LAnnotation::GetScalarY function:

dFontSize = A / sqrt( B * C )

For more information, refer to Low-Level Coordinate System for Annotations.