TextGetTrimming

Syntax

TrimmingMode = TextGetTrimming(Text)

Description

Retrieves the current text trimming mode set for the specified text object. Trimming determines how text is handled when it exceeds the layout bounds.

Parameters

Text
The handle of the text object whose trimming mode is to be retrieved.

Return Value

Returns the current trimming mode constant:

#PG_Text_Trimming_None
#PG_Text_Trimming_Character
#PG_Text_Trimming_Word

Returns #False (0) if the text handle is invalid (note: 0 corresponds to #PG_Text_Trimming_None, the default).

See Also

CreateText, TextSetTrimming, TextSetWidth, TextSetHeight, TextSetWrap

Supported OS

Windows, Linux