  |
GoFiler Legato Script Reference
Legato v 1.4i Application v 5.22a
|
| Table of Contents | < < Previous | Next >> |
Chapter Eight — Data Functions (continued)
DataSheetGetDefaultFont Function
Overview
The DataSheetGetDefaultFont function returns the default font information, if set, for a Data Sheet Object.
Syntax/Parameters
Syntax
string[] = DataSheetGetDefaultFont ( handle hSheet );
Parameters
hSheet
A handle to a Data Sheet Object.
Return Value
Returns a string array of properties for the default font or an empty array on error. Use the GetLastError function to retrieve error information.
Remarks
A Data Sheet Object need not have a default font. If a default font has not been set, the GetLastError function will return ERROR_EOD.
The array will have the following key names (data values, except the handle, are from the Windows LOGFONT structure; see MSDN):
| Key Name | Description | |||
| FontHandle | The Windows handle for the font in hex. | |||
| FaceName | Name of the font. | |||
| Height | The height, in logical units, of the font’s character cell or character. The character height value (also known as the em height) is the character cell height value minus the internal-leading value. | |||
| Width | The average width, in logical units, of characters in the font. If Width is zero, the aspect ratio of the device is matched against the digitization aspect ratio of the available fonts to find the closest match, determined by the absolute value of the difference. | |||
| Escapement | See MSDN. | |||
| Orientation | The angle, in tenths of degrees, between each character's base line and the x-axis of the device. | |||
| Weight | The weight of the font in the range 0 through 1000. For example, 400 is normal and 700 is bold. If this value is zero, a default weight is used. | |||
| Italic | An italic font if set to 1. | |||
| Underline | An underlined font if set to 1. | |||
| StrikeOut | A strikeout font if set to 1. | |||
| CharSet | The character set. The values are predefined as part of the Windows SDK. | |||
| OutPrecision | The output precision defines how closely the output must match the requested font’s height, width, character orientation, escapement, pitch, and font type. The values are predefined as part of the Windows SDK. | |||
| ClipPrecision | The clipping precision defines how to clip characters that are partially outside the clipping region. It can be one or more of the following values. | |||
| Quality | The output quality. | |||
| PitchAndFamily | The pitch and family of the font. |
Related Functions
Platform Support
Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL
Legato IDE, Legato Basic
| Table of Contents | < < Previous | Next >> |
© 2012-2024 Novaworks, LLC. All rights reserved worldwide. Unauthorized use, duplication or transmission prohibited by law. Portions of the software are protected by US Patents 10,095,672, 10,706,221 and 11,210,456. GoFiler™ and Legato™ are trademarks of Novaworks, LLC. EDGAR® is a federally registered trademark of the U.S. Securities and Exchange Commission. Novaworks is not affiliated with or approved by the U.S. Securities and Exchange Commission. All other trademarks are property of their respective owners. Use of the features specified in this language are subject to terms, conditions and limitations of the Software License Agreement.