hiSetFont
hiSetFont(
[ S_fontType
?name t_fontName
?size x_fontSize
?bold g_useBold
?italic g_useItalics
?fontInfo l_fontInfoDpl ]
)
=> t / nil
Description
Sets the required font attributes, such as font name, font size, or font weight for label, text, or ciw. If no argument is specified, then the Set Fonts window is displayed. In this window, you can set any of the valid fonts and click the Apply button to save the changes. If any of the key arguments is specified in this function, then it is mandatory to specify S_fontType.
Arguments
|
S_fontType
|
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 the current setting for the text font.
If ciw is set to any value other than text, then that value is used as the font 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.
|
|
?name t_fontName
|
The name of the font you want to use.
|
|
?size x_fontSize
|
The size of the font in pixels.
|
|
?bold g_useBold
|
Specify nil for the normal font or t for bold .
|
|
?italic g_useItalics
|
Specify nil for the normal font or t for italic.
|
|
?fontInfo l_fontInfoDpl
|
|
|
A disembodied property list (DPL) that contains the same properties as those returned by hiGetFontInfo.
|
Values Returned
|
t
|
Fonts are set.
|
|
nil
|
Font types are not valid. An error message gets displayed.
|
Examples
Displays the Set Fonts window.
hiSetFont( )
=> t
Changes the font size in CIW to 14 pixels.
hiSetFont( "ciw" ?size 14 )
=> t
Related Topics
Text Attribute Functions
hiGetFontInfo
Return to top
