Components | All | New | MacOS | Windows | Linux | iOS | ||||
Examples | Mac & Win | Server | Client | Guides | Statistic | FMM | Blog | Deprecated | Old |
XL.Format.SetAlignV
Sets the vertical alignment.
Component | Version | macOS | Windows | Linux | Server | iOS SDK |
XL | 3.5 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes |
Parameters
Parameter | Description | Example |
---|---|---|
Book | The reference to the workbook. Please use XL.LoadBook to load a file. | $ref |
Format | The index of the format in the book to target. | 0 |
Value | The new setting. | $value |
Result
Returns OK or error.
Description
Sets the vertical alignment.Possible values:
0 | Top |
1 | Center |
2 | Bottom |
3 | Justify |
4 | Distributed |
Examples
Create left aligned format with specific font:
#create a font
Set Variable [$textFont; Value:MBS( "XL.Book.AddFont"; $book)]
Set Variable [$r; Value:MBS( "XL.Font.SetSize"; $book; $textfont; 8)]
Set Variable [$r; Value:MBS( "XL.Font.SetName"; $book; $textfont; "Century Gothic")]
#create format
Set Variable [$textFormat; Value:MBS( "XL.Book.AddFormat"; $book)]
Set Variable [$r; Value:MBS( "XL.Format.SetFont"; $book; $textFormat; $textFont)]
Set Variable [$r; Value:MBS( "XL.Format.SetAlignH"; $book; $textFormat; 1) // left]
Set Variable [$r; Value:MBS( "XL.Format.SetAlignV"; $book; $textFormat; 0) // top ]
See also
- XL.Book.AddFont
- XL.Book.AddFormat
- XL.Font.SetName
- XL.Font.SetSize
- XL.Format.GetAlignH
- XL.Format.GetAlignV
- XL.Format.SetAlignH
- XL.Format.SetFont
- XL.Format.SetIndent
- XL.LoadBook
Example Databases
This function checks for a license.
Created 18th August 2014, last changed 19th October 2021