Name
get_string_extentsget_string_extentsGetStringExtentsget_string_extentsGetStringExtentsGetStringExtents — Get the spatial size of a string.
Herror get_string_extents(const Hlong WindowHandle, const char* Values, Hlong* Ascent, Hlong* Descent, Hlong* Width, Hlong* Height)
Herror T_get_string_extents(const Htuple WindowHandle, const Htuple Values, Htuple* Ascent, Htuple* Descent, Htuple* Width, Htuple* Height)
void GetStringExtents(const HTuple& WindowHandle, const HTuple& Values, HTuple* Ascent, HTuple* Descent, HTuple* Width, HTuple* Height)
Hlong HWindow::GetStringExtents(const HTuple& Values, Hlong* Descent, Hlong* Width, Hlong* Height) const
Hlong HWindow::GetStringExtents(const HString& Values, Hlong* Descent, Hlong* Width, Hlong* Height) const
Hlong HWindow::GetStringExtents(const char* Values, Hlong* Descent, Hlong* Width, Hlong* Height) const
static void HOperatorSet.GetStringExtents(HTuple windowHandle, HTuple values, out HTuple ascent, out HTuple descent, out HTuple width, out HTuple height)
int HWindow.GetStringExtents(HTuple values, out int descent, out int width, out int height)
int HWindow.GetStringExtents(string values, out int descent, out int width, out int height)
get_string_extentsget_string_extentsGetStringExtentsget_string_extentsGetStringExtentsGetStringExtents queries width and height of the output
size of a string using the font of the window. In addition, the
extension above and below the baseline is returned (AscentAscentAscentAscentAscentascent
and DescentDescentDescentDescentDescentdescent, respectively).
The sizes are measured in the coordinate system of the window (for
text windows in pixels). Using get_string_extentsget_string_extentsGetStringExtentsget_string_extentsGetStringExtentsGetStringExtents, it is
possible to determine text output and input independently from the
used font. The conversion from integer numbers and floating point
numbers to text strings is the same as in write_stringwrite_stringWriteStringwrite_stringWriteStringWriteString.
- Multithreading type: reentrant (runs in parallel with non-exclusive operators).
- Multithreading scope: global (may be called from any thread).
- Processed without parallelization.
ValuesValuesValuesValuesValuesvalues (input_control) string(-array) → HTupleHTupleHTupleVARIANTHtuple (string / real / integer) (string / double / int / long) (HString / double / Hlong) (char* / double / Hlong) (BSTR / double / Hlong) (char* / double / Hlong)
Values to consider.
Default value:
'test_string'
"test_string"
"test_string"
"test_string"
"test_string"
"test_string"
Maximum height above baseline.
Maximum extension below baseline.
get_string_extentsget_string_extentsGetStringExtentsget_string_extentsGetStringExtentsGetStringExtents returns 2 (H_MSG_TRUE) if the window is valid.
Otherwise an exception is raised.
open_windowopen_windowOpenWindowopen_windowOpenWindowOpenWindow,
open_textwindowopen_textwindowOpenTextwindowopen_textwindowOpenTextwindowOpenTextwindow,
set_fontset_fontSetFontset_fontSetFontSetFont
set_tpositionset_tpositionSetTpositionset_tpositionSetTpositionSetTposition,
write_stringwrite_stringWriteStringwrite_stringWriteStringWriteString,
read_stringread_stringReadStringread_stringReadStringReadString,
read_charread_charReadCharread_charReadCharReadChar
get_font_extentsget_font_extentsGetFontExtentsget_font_extentsGetFontExtentsGetFontExtents,
set_tpositionset_tpositionSetTpositionset_tpositionSetTpositionSetTposition,
set_fontset_fontSetFontset_fontSetFontSetFont
Foundation