LAnnText::SetFontSize
#include "ltwrappr.h"
virtual L_INT LAnnText::SetFontSize(dFontSize, uFlags=0)
L_DOUBLE dFontSize; |
/* the font size to set */ |
L_UINT uFlags; |
/* flags that determine which objects to process */ |
NOTE: |
THIS FUNCTION IS NOW INHERITED DIRECTLY FROM THE PARENT LANNOTATION CLASS. |
Sets the font size of the annotation object.
Parameter |
Description |
|
dFontSize |
The font size to set, expressed as an unscaled value relative to the container. |
|
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: |
|
|
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 LAnnContainer::GetSelectItems() 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 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.
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. |
Win32, x64.
See Also
Functions: |
|
Topics: |
Example
For an example, refer to LAnnText::GetFontSize.