get_font_extentsT_get_font_extentsGetFontExtentsGetFontExtents (Operator)
Name
get_font_extentsT_get_font_extentsGetFontExtentsGetFontExtents — Get the maximum size of all characters of a font.
Signature
Description
get_font_extentsget_font_extentsGetFontExtentsGetFontExtentsGetFontExtents queries the maximum width
(MaxWidthMaxWidthMaxWidthMaxWidthmaxWidth), height (MaxHeightMaxHeightMaxHeightMaxHeightmaxHeight), and extension
above and below the baseline (MaxAscentMaxAscentMaxAscentMaxAscentmaxAscent and
MaxDescentMaxDescentMaxDescentMaxDescentmaxDescent, respectively) of the font that is currently set
for the window WindowHandleWindowHandleWindowHandleWindowHandlewindowHandle. The sizes are measured in
pixels.
Execution Information
- Multithreading type: reentrant (runs in parallel with non-exclusive operators).
- Multithreading scope: global (may be called from any thread).
- Processed without parallelization.
Parameters
WindowHandleWindowHandleWindowHandleWindowHandlewindowHandle (input_control) window → HWindow, HTupleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)
Window handle.
MaxAscentMaxAscentMaxAscentMaxAscentmaxAscent (output_control) extent.y → HTupleHTupleHtuple (integer / real) (int / long / double) (Hlong / double) (Hlong / double)
Maximum height above baseline.
MaxDescentMaxDescentMaxDescentMaxDescentmaxDescent (output_control) extent.y → HTupleHTupleHtuple (integer / real) (int / long / double) (Hlong / double) (Hlong / double)
Maximum extension below baseline.
MaxWidthMaxWidthMaxWidthMaxWidthmaxWidth (output_control) extent.x → HTupleHTupleHtuple (integer / real) (int / long / double) (Hlong / double) (Hlong / double)
Maximum character width.
MaxHeightMaxHeightMaxHeightMaxHeightmaxHeight (output_control) extent.y → HTupleHTupleHtuple (integer / real) (int / long / double) (Hlong / double) (Hlong / double)
Maximum character height.
Result
get_font_extentsget_font_extentsGetFontExtentsGetFontExtentsGetFontExtents returns 2 (H_MSG_TRUE) if the window is valid.
Otherwise an exception is raised.
Possible Predecessors
open_windowopen_windowOpenWindowOpenWindowOpenWindow,
set_fontset_fontSetFontSetFontSetFont
Possible Successors
set_tpositionset_tpositionSetTpositionSetTpositionSetTposition,
write_stringwrite_stringWriteStringWriteStringWriteString,
read_stringread_stringReadStringReadStringReadString,
read_charread_charReadCharReadCharReadChar
See also
get_string_extentsget_string_extentsGetStringExtentsGetStringExtentsGetStringExtents,
set_tpositionset_tpositionSetTpositionSetTpositionSetTposition,
set_fontset_fontSetFontSetFontSetFont
Module
Foundation