Description
The PlotFont object is used to configure the fonts associated with a PlotWindow object. This object is not creatable in script, but an instance is always created as a child object of the PlotAxis, PlotLegend, and PlotTitle objects, as seen in the examples below:
PlotWindow1.XAxis.LabelsFont.Bold = 1;
PlotWindow1.Legend.Font.Bold = 1;
PlotWindow1.PlotTitle.Font.Bold = 1;
You can assign PlotFont objects using the = operator.
Users cannot create instances of this type of object. However, users can access instances of this object type that have been created indirectly, for example as children of other objects. Users can also access any static properties and methods on this object type.
Inheritance Hierarchy: Object->PlotBaseObject->PlotFont
Available In Editions:
Engineer
Mission
Timing Precision Mode
This page describes functionality in nanosecond timing precision mode.
Click here to see the documentation for this object in millisecond timing precision mode.
Name
|
Description
|
Attributes
|
Bold
|
Sets whether the current font is bold.
|
Type: Variable
Access: Read/Write
|
DeclaredName
|
The name of the object as declared.
|
Type: String
Access: Read-Only
|
DisplayName
|
The name displayed for this object in output windows such as views, plots, and reports.
|
Type: String
Access: Read/Write
|
Italic
|
Sets whether the current font is italic.
|
Type: Variable
Access: Read/Write
|
ObjectId
|
The unique identifier for the object.
|
Type: Variable
Access: Read-Only
|
ObjectType
|
The type of the object.
|
Type: String
Access: Read-Only
|
Size
|
Sets the size in points of the current font.
|
Type: Variable
Access: Read/Write
Units: points
|
Strikeout
|
Sets whether the current font has a strike out through it.
|
Type: Variable
Access: Read/Write
|
Typeface
|
Sets the typeface for the current font. This can be set to the name of any typeface available to the computer. Common examples include "Verdana", "Arial", etc. A full listing of the available typefaces can be found in the FreeFlyer User Preferences menu on the "Editors" page, or on the object editor of any PlotWindow object through the "Additional Options" button on the Properties page. If a typeface does not exist on the machine, the default will be used.
|
Type: String
Access: Read/Write
|
Underline
|
Sets whether the current font is underlined.
|
Type: Variable
Access: Read/Write
|
|
Name
|
Description
|
ClearSavedStates
|
Clears previous saved states for this object.
|
GetFromFile
|
Load the object state from the specified FreeFlyer object file.
|
GetFromString
|
Load the object state from the specified string.
|
PutToFile
|
Convert the object state to FreeFlyer object xml and write to a file.
|
PutToString
|
Convert the object state to FreeFlyer object xml and return as a string.
|
ReferenceEquals
|
Returns 1 if the argument refers to the calling object and 0 otherwise.
|
Restore
|
Restore an object's state from a previously saved state.
|
Save
|
Save the object's state so that it can be restored later.
|
|
See also
PlotWindow Guide
| 