Namespace: Consultingwerk.Util.DocumentConverter
Class 
TextRunFormat Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.Util.DocumentConverter.TextRunFormat

Inherits: Progress.Lang.Object


Navigate to: Methods | Constructors | Events | Properties | ProDatasets | Temp-Tables



Top Method Summary
Options Name Purpose
Consultingwerk.Util.DocumentConverter.TextRunFormat CloneFormat () Returns a copy of this TextRunFormat instance
LONGCHAR GetFontName () Returns the font face of the run
LONGCHAR GetHyperlinkUrl () Returns the target URL when the run is a hyperlink
LOGICAL HasAllowedScheme (memptr, integer) Returns if the normalised target names no scheme or one of the allowed schemes
LOGICAL IsEqualTo (TextRunFormat) Returns if the given TextRunFormat has the same formatting as this instance
LOGICAL IsHyperlink () Returns if the run is a hyperlink
LOGICAL IsSameText (longchar, longchar) Returns if two longchar values hold the same text regardless of the session code page
LOGICAL IsSchemeName (memptr, integer, character) Returns if the leading bytes are the given scheme name
Reset () Resets the character formatting to the default
LONGCHAR SanitizeHyperlinkUrl (longchar) Returns the given hyperlink target in the form the model stores it, or an empty value when the target may not be stored
SetFontName (longchar) Sets the font face of the run
SetHyperlinkUrl (longchar) Sets the target URL of the run

Top Constructor Summary
Options Name Purpose
TextRunFormat () Creates a new TextRunFormat instance

Top Property Summary
Options Name Purpose
LOGICAL Bold
LOGICAL Code
INTEGER FontSize
INTEGER ForeColor
LOGICAL Italic
LOGICAL Strikethrough
LOGICAL Subscript
LOGICAL Superscript
LOGICAL Underline
Consultingwerk.Util.DocumentConverter.UnderlineStyleEnum UnderlineStyle


Method Detail
Top

Consultingwerk.Util.DocumentConverter.TextRunFormat CloneFormat ()
Purpose: Returns a copy of this TextRunFormat instance
Notes: Used by the readers to push the current character state on
their group stack, so that a later change does not modify
the state that was pushed

Returns Consultingwerk.Util.DocumentConverter.TextRunFormat
The new TextRunFormat instance with the same property values
Top

LONGCHAR GetFontName ()
Purpose: Returns the font face of the run
Notes: An empty value marks a run that uses the default font of the
document

Returns LONGCHAR
The longchar with the font face
Top

LONGCHAR GetHyperlinkUrl ()
Purpose: Returns the target URL when the run is a hyperlink
Notes: An empty value marks a run that is not a hyperlink

Returns LONGCHAR
The longchar with the target URL
Top

LOGICAL HasAllowedScheme (memptr, integer)
Purpose: Returns if the normalised target names no scheme or one of the
allowed schemes
Notes: The scheme is the run of bytes before the first colon, provided
it begins with an ASCII letter and holds ASCII letters, digits,
plus, minus and period only. Any other byte before the colon -
a slash, a question mark, a number sign, a blank, a byte
outside ASCII - means the target names no scheme and is
relative. The allowed schemes are compared case insensitively.

Parameters:
pmData MEMPTR
The UTF-8 bytes of the normalised target
piBytes INTEGER
The number of bytes
Returns LOGICAL
TRUE when the target may be stored
Top

LOGICAL IsEqualTo (TextRunFormat)
Purpose: Returns if the given TextRunFormat has the same formatting as
this instance
Notes: Used to merge adjacent runs with identical formatting, which
is required for the canonical output of the writers

Parameters:
poFormat Consultingwerk.Util.DocumentConverter.TextRunFormat
The TextRunFormat instance to compare this instance with
Returns LOGICAL
TRUE when every formatting property has the same value
Top

LOGICAL IsHyperlink ()
Purpose: Returns if the run is a hyperlink
Notes:

Returns LOGICAL
TRUE when the run carries a target URL
Top

LOGICAL IsSameText (longchar, longchar)
Purpose: Returns if two longchar values hold the same text
regardless of the session code page
Notes: An ABL string comparison collates through -cpinternal and
raises for a character the session code page does not know, so
the values are compared through their base64 encoding - which
is ASCII and therefore always comparable. The unknown value and
an empty value count as equal.

Parameters:
plcValue1 LONGCHAR
The first value
plcValue2 LONGCHAR
The second value
Returns LOGICAL
TRUE when both values hold the same text
Top

LOGICAL IsSchemeName (memptr, integer, character)
Purpose: Returns if the leading bytes are the given scheme name
Notes: Compares case insensitively; the scheme name is lower case ASCII

Parameters:
pmData MEMPTR
The bytes to test
piLength INTEGER
The number of bytes of the scheme in the data
pcScheme CHARACTER
The lower case scheme name to compare with
Returns LOGICAL
TRUE when the bytes are that scheme name
Top

Reset ()
Purpose: Resets the character formatting to the default
Notes: Corresponds to the RTF plain control word

Top

LONGCHAR SanitizeHyperlinkUrl (longchar)
Purpose: Returns the given hyperlink target in the form the model stores
it, or an empty value when the target may not be stored
Notes: See the class header (SCL-5864). Works on the UTF-8 bytes: the
target may carry characters the session code page does not
know, and INDEX or a string comparison on such a value raises
or collates through -cpinternal. Returns the same value when it
is passed its own result.

Parameters:
plcUrl LONGCHAR
The target URL to check
Returns LONGCHAR
The normalised target fixed to UTF-8, empty when it names a scheme that is not allowed
Top

SetFontName (longchar)
Purpose: Sets the font face of the run
Notes: The unknown value is stored as an empty value

Parameters:
plcFontName LONGCHAR
The font face
Top

SetHyperlinkUrl (longchar)
Purpose: Sets the target URL of the run
Notes: The target is stored the way SanitizeHyperlinkUrl returns it, so
a target with a scheme that is not allowed is stored as an
empty value and the run is no hyperlink (SCL-5864). The unknown
value is stored as an empty value.

Parameters:
plcHyperlinkUrl LONGCHAR
The target URL


Constructor Detail
Top

TextRunFormat ()
Purpose: Creates a new TextRunFormat instance
Notes: FIX-CODEPAGE has to be applied before the fields hold a value



Property Detail
Top

LOGICAL Bold

Returns LOGICAL
Top

LOGICAL Code

Returns LOGICAL
Top

INTEGER FontSize

Returns INTEGER
Top

INTEGER ForeColor

Returns INTEGER
Top

LOGICAL Italic

Returns LOGICAL
Top

LOGICAL Strikethrough

Returns LOGICAL
Top

LOGICAL Subscript

Returns LOGICAL
Top

LOGICAL Superscript

Returns LOGICAL
Top

LOGICAL Underline

Returns LOGICAL
Top

Consultingwerk.Util.DocumentConverter.UnderlineStyleEnum UnderlineStyle

Returns Consultingwerk.Util.DocumentConverter.UnderlineStyleEnum


©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       19.09.2026 10:19:23