hiGetFontInfo
hiGetFontInfo(
S_fontType
)
=> l_fontInfoDpl / l_fontInfoDpls / nil
Description
Returns the Disembodied Property List (DPL), which contains the name, size, weight, and italic style along with the description of the font.
Argument
|
S_fontType
|
Specifies one of the following strings:
-
"
text" or 'text: Font used in CIW and encapsulation output windows, viewfiles, and the input area of text fields. -
"
label" or 'label: Font used in banner labels, menus, and forms. -
"
ciw" or 'ciw: Font used solely by CIW, with a default value of text. This is a special-case value that indicates that CIW is using the current setting for the text font.
If ciw is set to any value other than text, then that value is the font used by CIW for its input and output areas.
If the text font is changed, the ciw font gets changed (if it is still set to text). Additionally, if at any time during a session, if the ciw font is specifically changed to anything other than text, then changing the text font does not modify the ciw font from that point forward.
The purpose of the ciw font is to allow you to independently change CIW fonts without impacting forms that are using the text format. -
"
all" or 'all: Font used for ciw, label, and text.
|
Values Returned
|
l_fontInfoDpl / l_fontInfoDpls
|
|
|
The Disembodied Property List (DPL) that contains the name, size, bold, and italic along with the description of the font for any of the values except "all" or 'all. If the value is specified as "all" or 'all, a DPL is returned with the properties of ciw, text, and label.
|
|
nil
|
The font type is invalid.
|
Examples
Returns the DPL containing the name, size, bold, and italic style of the font type, ciw.
hiGetFontInfo( "ciw" )
=> ( nil name "text" size 11
bold 50 italic nil
)
Returns the DPLs containing the name, size, bold, and italic style of the font types, text, ciw, and label, respectively.
hiGetFontInfo( "all" )
=> ( nil text (nil name "Roboto Mono" size 11
bold 50 italic nil
)
ciw ( nil name "Roboto Mono" size 12
bold 50 italic nil
)
label ( nil name "Open Sans" size 11
bold 50 italic nil
)
)
)
Related Topics
Text Attribute Functions
Return to top
