Notebook Object properties
To view properties, arguments, and syntax for notebook objects, see the reference topics that follow.
Arrow properties
|  |
Syntax
[NBName]Sheet:ObjName.Property
Description
Lets you specify the arrow properties.
The following table lists properties and syntax for the Arrow object:
|
Property
|
Syntax
|
Description
|
|
Arrow
|
[NBName]Sheet:ObjName.Property
|
NBName is the name of the active notebook
Sheet is the name of the sheet containing the object
ObjName is either the object ID number or the name of the object
Property is one of the strings listed in the Argument column of the dialog control property tables
|
|
Border Settings
|
Border_Settings;S0W1 | S0W2 | S0W3 | S0W4 | S1W1 | S2W1 | S3W1 | S4W1 | S5W1, Red, Blue, Green
|
|
|
Fill Settings
|
Fill_Settings
|
|
|
Object Name
|
Object_Name;ObjName
|
|
|
Protection
|
Protection;Yes | No
|
|
Bitmap properties
| |
Syntax
[NBName]Sheet:ObjName.Property
Description
Lets you specify the bitmap properties.
The following table lists properties and syntax for the Bitmap object:
|
Property
|
Syntax
|
Description
|
|
Bitmap
|
[NBName]Sheet:ObjName.Property
|
NBName is the name of the active notebook
Sheet is the name of the sheet containing the object
ObjName is either the object ID number or the name of the object
Property is one of the strings listed in the Argument column of the dialog control property tables
|
|
Border Color
|
Border_Color
|
|
|
Box Type
|
Box_Type;None | Thin | Medium | Thick, DropShadow?(Yes | No), Transparent?(Yes | No)
|
|
|
Box Type
|
Box_Type.Frame_Line_Style;None | Thin | Medium | Thick
|
|
|
Drop Shadow
|
Box_Type.Drop_Shadow;Yes | No
|
|
|
Transparent
|
Box_Type.Transparent;Yes | No
|
|
|
Object Name
|
Object_Name;ObjName
|
|
Button properties
| |
Syntax
[NBName]Sheet:ObjName.Property
Description
Lets you specify the button properties.
The following table lists properties and syntax for the Button object:
|
Property
|
Syntax
|
Description
|
|
Button
|
[NBName]Sheet:ObjName.Property
|
NBName is the name of the active notebook
Sheet is the name of the sheet containing the object
ObjName is either the object ID number or the name of the object
Property is one of the strings listed in the Argument column of the dialog control property tables
|
|
Border Color
|
Border_Color
|
|
|
Box Type
|
Box_Type;None | Thin | Medium | Thick, DropShadow?(Yes | No)
|
|
|
Box Type
|
Box_Type.Frame_Line_
Style;None | Thin | Medium | Thick
|
|
|
Drop Shadow
|
Box_Type.Drop_Shadow;Yes | No
|
|
|
Label Text
|
Label_Text;LabelText
|
|
|
Macro
|
Macro;Macro
|
|
|
Object Name
|
Object_Name;ObjName
|
|
Example
{SetObjectProperty "A:Button1.border_color","0;128;255"}
Cell properties
| |
Syntax
[NBName]Sheet:ObjName.Property
Description
Lets you specify the cell properties.
The following table lists properties and syntax for the Cell object:
|
Property
|
Syntax
|
Description
|
|
Cell
|
[NBName]BlockAddress.Property
|
NBName is the name of the active notebook
Sheet is the name of the sheet containing the object
ObjName is either the object ID number or the name of the object
Property is one of the strings listed in the Argument column of the dialog control property tables
|
|
Alignment
|
Alignment;General | Left | Right | Center | Center Across Block, Top | Center | Bottom, WrapText?(Yes | No), Horizontal | Vertical
|
|
|
Horizontal
|
Alignment.Horizontal;General | Left | Right | Center | Center Across Block
|
|
|
Orientation
|
Alignment.Orientation;Horizontal | Vertical
|
|
|
Vertical
|
Alignment.Vertical;Top | Center | Bottom
|
|
|
Wrap Text
|
Alignment.WrapText;Yes | No
|
|
|
Column Width
|
Column_Width;Operation, WidthInTwips, ColSpacing
|
|
|
Auto Width
|
Column_Width;Auto Width,, ExtraSpace
|
|
|
Reset Width
|
Column_Width;Reset Width
|
|
|
Set Width
|
Column_Width;Set Width, NewWidthInTwips
|
|
|
Constraints
|
Constraints;Protect | Unprotect, General | Labels Only | Dates Only
|
|
|
Data Entry Input
|
Constraints.Data_Entry_Input;General | Labels Only | Dates Only
|
|
|
Protection
|
Constraints.Protection Protect|Unprotect
|
|
|
Font
|
Font
|
|
|
Line Drawing
|
Line_Drawing;Left, Top, Right, Bottom, Vert, Horiz, LeftColor, TopColor, RightColor, BottomColor, VertColor, HorizColor
|
Note: The first six settings can take NoChange | Clear | Thin | Thick | Double;the last six settings can take 0-15;@PROPERTY and {GETPROPERTY} always return default Line Drawing property settings.
|
|
Number Value (H)
|
Number_Value;the value in the cell
|
|
|
Numeric Format
|
Numeric_Format;Format, Precision | Type
|
|
|
Reveal/Hide
|
Reveal/Hide;Row | Column, Reveal | Hide
|
|
|
Row Height
|
Row_Height;Operation, Size
|
|
|
Reset Height
|
Row_Height;Reset Height
|
|
|
Set Height
|
Row_Height;Set Height, NewSize
|
|
|
Selection (H, R)
|
Selection;the coordinates of the selected cells
|
|
|
Shading
|
Shading;Color1, Color2, Blend
|
|
|
Color Blend 1
|
Shading.Color_1;0-15
|
|
|
Color Blend 2
|
Shading.Color_2;0-15
|
|
|
Select Color Blend
|
Shading.Blend;Blend1 | Blend2 | Blend3 | Blend4 | Blend5 | Blend6 | Blend7
|
|
|
String Value (H)
|
String_Value;the label in the cell
|
|
|
Style (H)
|
Style;the named style of the active cells
|
|
|
Text Color
|
Text_Color;0-15
|
|
|
Value (H)
|
Value;the contents of the cell (as they appear on the input line)
|
|
Example
{SETOBJECTPROPERTY "A:A23.Numeric_Format","Currency,2"}
|
•
|
|
If a property name is followed by (H), it is a hidden property and does not appear in the object’s Property dialog.
|
|
•
|
|
If a property name is followed by (R), you cannot set it with a macro command or link command; it is a read only property.
|
Chart/Map properties
| |
Syntax
[NBName]Sheet:ObjName.Property
Description
Lets you specify the chart and map properties.
The following table lists properties and syntax for the Chart object and the Map object:
|
Property
|
Syntax
|
Description
|
|
Chart
|
[NBName]Sheet:ObjName.Property
|
NBName is the name of the active notebook
Sheet is the name of the sheet containing the object
ObjName is either the object ID number or the name of the object
Property is one of the strings listed in the Argument column of the dialog control property tables
|
|
Border Color
|
Border_Color
|
|
|
Box Type
|
Box_Type;None | Thin | Medium | Thick, DropShadow?(Yes | No), Transparent?(Yes | No)
|
|
|
Box Type
|
Box_Type.Frame_Line_
Style;None | Thin | Medium | Thick
|
|
|
Drop Shadow
|
Box_Type.Drop_Shadow;Yes | No
|
|
|
Transparent
|
Box_Type.Transparent;Yes | No
|
|
|
Object Name
|
Object_Name;ObjName
|
|
|
Protection
|
Protection;Yes | No
|
|
|
Source Chart/Map
|
Source_Chart/ Source_Map;Name
|
|
Ellipse properties
| |
Syntax
[NBName]Sheet:ObjName.Property
Description
Lets you specify the ellipse properties.
The following table lists properties and syntax for the Ellipse object:
|
Property
|
Syntax
|
Description
|
|
Ellipse
|
[NBName]Sheet:ObjName.Property
|
NBName is the name of the active notebook
Sheet is the name of the sheet containing the object
ObjName is either the object ID number or the name of the object
Property is one of the strings listed in the Argument column of the dialog control property tables
|
|
Border Settings
|
Border_Settings;S0W1 | S0W2 | S0W3 | S0W4 | S1W1 | S2W1 | S3W1 | S4W1 | S5W1, Red, Blue, Green
|
|
|
Fill Settings
|
Fill_Settings
|
|
|
Object Name
|
Object_Name;ObjName
|
|
|
Protection
|
Protection;Yes | No
|
|
Line properties
| |
Syntax
[NBName]Sheet:ObjName.Property
Description
Lets you specify the line properties.
The following table lists properties and syntax for the Line object:
|
Property
|
Syntax
|
Description
|
|
Line
|
[NBName]Sheet:ObjName.Property
|
NBName is the name of the active notebook
Sheet is the name of the sheet containing the object
ObjName is either the object ID number or the name of the object
Property is one of the strings listed in the Argument column of the dialog control property tables
|
|
Line Settings
|
Line_Settings;S0W1 | S0W2 | S0W3 | S0W4 | S1W1 | S2W1 | S3W1 | S4W1 | S5W1, Red, Blue, Green
|
|
|
Object Name
|
Object_Name;ObjName
|
|
|
Protection
|
Protection;Yes | No
|
|
Notebook properties
| |
Syntax
[NBName].Property
Description
Lets you specify the notebook properties.
The following table lists properties and syntax for the Notebook object:
|
Property
|
Syntax
|
Description
|
|
Notebook
|
[NBName].Property
|
NBName is the name of the active notebook
Property is one of the strings listed in the Argument column of the dialog control property tables
|
|
Display
|
Display;VertScroll?(Yes | No), HorzScroll?(Yes | No), Tabs?(Yes | No), Objects (Show All | Show Outline | Hide)
|
|
|
Horizontal Scroll Bar
|
Display.Show_HorizontalScroller;Yes | No
|
|
|
Objects
|
Display.Objects;Show All | Show Outline | Hide
|
|
|
Sheet Tabs
|
Display.Show_Tabs;Yes | No
|
|
|
Vertical Scroll Bar
|
Display.Show_VerticalScroller;Yes | No
|
|
|
Group Mode (H)
|
Group_Mode;On enables Group Mode;Off disables group mode
|
|
|
Macro Library
|
Macro_Library;Yes | No
|
|
|
Palette
|
Palette;Color1, Color2, …, Color16
|
|
|
Color 1
|
Palette.Color_1
|
|
|
Color 2
|
Palette.Color_2
|
|
|
Color 3
|
Palette.Color_3
|
|
|
Color 4
|
Palette.Color_4
|
|
|
Color 5
|
Palette.Color_5
|
|
|
Color 6
|
Palette.Color_6
|
|
|
Color 7
|
Palette.Color_7
|
|
|
Color 8
|
Palette.Color_8
|
|
|
Color 9
|
Palette.Color_9
|
|
|
Color 10
|
Palette.Color_10
|
|
|
Color 11
|
Palette.Color_11
|
|
|
Color 12
|
Palette.Color_12
|
|
|
Color 13
|
Palette.Color_13
|
|
|
Color 14
|
Palette.Color_14
|
|
|
Color 15
|
Palette.Color_15
|
|
|
Color 16
|
Palette.Color_16
|
|
|
Password Level
|
Password_Level;None | Low | Medium | High
|
|
|
Recalc Settings
|
Recalc_Settings;Automatic | Manual | Background, Natural | Column-wise | Row-wise, Iterations, <CompileFormulas?(0 | 1)>, <AuditErrors?(0 | 1)>
|
|
|
Statistics (R)
|
Statistics;Filename, Directory, Created(Date Time), Last_Saved(Date Time), Last_Saved_By, Revision_Number
|
|
|
Summary
|
Summary;Title, Subject, Author, Keywords, Comments
|
|
|
System
|
System;Yes | No
|
|
|
Zoom Factor
|
Zoom_Factor;10-400
|
|
Example
{Notebook.Zoom_Factor"200"}
|
•
|
|
If a property name is followed by (H), it is a hidden property and does not appear in the object’s Property dialog.
|
|
•
|
|
If a property name is followed by (R), you cannot set it with a macro command or link command; it is a read only property.
|
OLE properties
| |
Syntax
[NBName]Sheet:ObjName.Property
Description
Lets you specify the OLE properties.
The following table lists properties and syntax for the OLE object:
|
Property
|
Syntax
|
Description
|
|
OLE
|
|
NBName is the name of the active notebook
Sheet is the name of the sheet containing the object
ObjName is either the object ID number or the name of the object
Property is one of the strings listed in the Argument column of the dialog control property tables
|
|
Border Color
|
Border_Color
|
|
|
Box Type
|
Box_Type
;None | Thin | Medium | Thick, DropShadow?(Yes | No), Transparent?(Yes | No)
|
|
|
Box Type
|
Box_Type.Frame_Line_Style;None | Thin | Medium | Thick
|
|
|
Drop Shadow
|
Box_Type.Drop_Shadow;Yes | No
|
|
|
Transparent
|
Box_Type.Transparent;Yes | No
|
|
|
Object Name
|
Object_Name;ObjName
|
|
|
OLE
|
OLE;AutoResize?(Yes | No), AutoLinkUpdate?(Yes | No)
|
|
|
Protection
|
Protection;Yes | No
|
|
Example
{Setobjectproperty "A:Embedded1.Box_Type";"Thick;Yes;Yes"}
Picture properties
| |
Syntax
[NBName]Sheet:ObjName.Property
Description
Lets you specify the picture properties.
The following table lists properties and syntax for the Picture object:
|
Property
|
Syntax
|
Description
|
|
Picture
|
|
NBName is the name of the active notebook
Sheet is the name of the sheet containing the object
ObjName is either the object ID number or the name of the object
Property is one of the strings listed in the Argument column of the dialog control property tables
|
|
Border Color
|
Border_Color
|
|
|
Box Type
|
Box_Type;None | Thin | Medium | Thick, DropShadow?(Yes | No), Transparent?(Yes | No)
|
|
|
Box Type
|
Box_Type.Frame_Line_Style;None | Thin | Medium | Thick
|
|
|
Drop Shadow
|
Box_Type.Drop_Shadow;Yes | No
|
|
|
Transparent
|
Box_Type.Transparent;Yes | No
|
|
|
Object Name
|
Object_Name;ObjName
|
|
|
Protection
|
Protection;Yes | No
|
|
Rectangle properties
| |
Syntax
[NBName]Sheet:ObjName.Property
Description
Lets you specify the rectangle properties.
The following table lists properties and syntax for the Rectangle object:
|
Property
|
Syntax
|
Description
|
|
Rectangle
|
[NBName]Sheet:ObjName.Property
|
NBName is the name of the active notebook
Sheet is the name of the sheet containing the object
ObjName is either the object ID number or the name of the object
Property is one of the strings listed in the Argument column of the dialog control property tables
|
|
Border Settings
|
Border_Settings;S0W1 | S0W2 | S0W3 | S0W4 | S1W1 | S2W1 | S3W1 | S4W1 | S5W1, Red, Blue, Green
|
|
|
Fill Settings
|
Fill_Settings
|
|
|
Object Name
|
Object_Name;ObjName
|
|
|
Protection
|
Protection;Yes | No
|
|
Rounded Rectangle properties
| |
Syntax
[NBName]Sheet:ObjName.Property
Description
Lets you specify the rounded rectangle properties.
The following table lists properties and syntax for the Rounded Rectangle object:
|
Property
|
Syntax
|
Description
|
|
Rounded Rectangle
|
[NBName]Sheet:ObjName.Property
|
NBName is the name of the active notebook
Sheet is the name of the sheet containing the object
ObjName is either the object ID number or the name of the object
Property is one of the strings listed in the Argument column of the dialog control property tables
|
|
Border Settings
|
Border_Settings;S0W1 | S0W2 | S0W3 | S0W4 | S1W1 | S2W1 | S3W1 | S4W1 | S5W1, Red, Blue, Green
|
|
|
Fill Settings
|
Fill_Settings
|
|
|
Object Name
|
Object_Name;ObjName
|
|
|
Protection
|
Protection;Yes | No
|
|
Text Box properties
| |
Syntax
[NBName]Sheet:ObjName.Property
Description
Lets you specify the text box properties.
The following table lists properties and syntax for the Text Box object:
|
Property
|
Syntax
|
Description
|
|
Text Box
|
[NBName]Sheet:ObjName.Property
|
NBName is the name of the active notebook
Sheet is the name of the sheet containing the object
ObjName is either the object ID number or the name of the object
Property is one of the strings listed in the Argument column of the dialog control property tables
|
|
Alignment
|
Alignment;Left | Right | Center, WordWrap, TabStops
|
|
|
Box Settings
|
Box_Settings;No box | Single outline | Rounded corners | Double outline | Thick outline 1 | Thick rounded corners | Three dimensional | Thick outline 2 | Bevel out | Shadowed | Thick outline 3 | Bevel in, Red, Blue, Green
|
|
|
Fill Settings
|
Fill_Settings
|
|
|
Object Name
|
Object_Name;ObjName
|
|
|
Protection
|
Protection;Yes | No
|
|
|
Text Font
|
Text_Font
|
|
|
Text Settings
|
Text_Settings
|
|
Notebook Object properties