Widget Designer > Script Language > Object and Member Notation (dot syntax)

Show/Hide hidden text

This chapter gives an overview of the members available for Pages and Windows. As explained in the topic"Object and Member Notation (dot syntax)", all kinds of objects can be addressed in the scripting language by using their members which set (or return if applicable) properties or methods of that object. Please refer to the chapter "Script Language" for more details about scripting in general.

Page.Color1

PageName.Color1

Example:
vcolor = Page1.Color1

Alternative Example:
vcolor = Project.Page("Page1").Color1
vcolor = Context.Page.Color1

This returns the top color of the specified page as a color value.
The first example shows how to use it with a color variable named "vcolor".

You could also write it into a Widget, e.g. a ColorPicker via the script: ColorPicker1.SelectedColor = Page1.Color1
or simply display it in the Debug Logger: DebugMessage(Page1.Color1)

In return, you can also assign a new color to:
Page1.Color1 = vcolor
Page1.Color1 = "007DFF".ToColor
Page1.Color1 = ColorPicker1.SelectedColor

Page.Color2

PageName.Color2

Example:
vcolor = Page1.Color2

Alternative Example:
vcolor = Project.Page("Page1").Color2
vcolor = Context.Page.Color2

This returns the bottom color of the specified page as a color value.
The first example shows how to use it with a color variable named "vcolor".

You could also write it into a Widget, e.g. a Label via the script: Label1.Text = Page1.Color2
or simply display it in the Debug Logger: DebugMessage(Page1.Color2)

In return, you can also assign a new color to:
Page1.Color2 = vcolor
Page1.Color2 = "007DFF".ToColor
Page1.Color2 = ColorPicker1.SelectedColor

Page.Name

PageName.Name

Example:
vstring = Page1.Name

Alternative Example:
vstring = Project.Page("Page1").Name
vstring = Context.Page.Name

This returns the name of the specified page as a string value.
The first example shows how to use it with a string variable named "vstring".

You could also write it into a Widget, e.g. a Label via the script: Label1.Text = Page1.Name
or simply display it in the Debug Logger: DebugMessage(Page1.Name)

In return, you can also assign a new name to it as follows:
Page1.Name = "newOne"

Page.OffsetX

PageName.OffsetX

Example:
vdouble = Page1.OffsetX

Alternative Example:
vdouble = Project.Page("Page1").OffsetX
vdouble = Context.Page.OffsetX

The first example shows how to use it with a double variable named "vdouble".

You could also write it into a Widget, e.g. a Label via the script: Label1.Text = Page1.OffsetX
or simply display it in the Debug Logger: DebugMessage(Page1.OffsetX)

Page.OffsetY

PageName.OffsetY

Example:
vdouble = Page1.OffsetY

Alternative Example:
vdouble = Project.Page("Page1").OffsetY
vdouble = Context.Page.OffsetY

The first example shows how to use it with a double variable named "vdouble".

You could also write it into a Widget, e.g. a Label via the script: Label1.Text = Page1.OffsetY
or simply display it in the Debug Logger: DebugMessage(Page1.OffsetY)

Page.WindowName

PageName.WindowName

Example:
vstring = Page1.WindowName

Alternative Example:
vstring = Project.Page("Page1").WindowName
vstring = Context.Page.WindowName

This returns the name of the Window to which the specified page belongs to as a string value.
The first example shows how to use it with a string variable named "vstring".

You could also write it into a Widget, e.g. a Label via the script: Label1.Text = Page1.WindowName
or simply display it in the Debug Logger: DebugMessage(Page1.WindowName)

Window.CustomHeader

WindowName.CustomHeader

Example:
vstring = Window1.CustomHeader

Alternative Example:
vstring = Project.Page("Window1").CustomHeader
vstring = Context.Window.CustomHeader

This returns the Custom HTML Header that was saved for the Window either in the dialog Windows > Edit Window or via this command.
The Custom Header enables you to implement your own HTML5 based design in the Widget Designer interface. The header affects the objects in the specified window.

The first example shows how to use it with a string variable named "vstring".
You could also write it into a Widget, e.g. a Label via the script: Label1.Text = Window1.CustomHeader
or simply display it in the Debug Logger: DebugMessage(Window1.CustomHeader)

You can assign the header with this member as follows:
Context.Window.CustomHeader = "<!DOCTYPE html>
<html>
<style>
.WdWindow{
position: relative;
width: 1200px;
margin: 0 auto;
}
</style>
</html>"

This example script causes the pages to be located not at the left side of your window but in the middle, assuming that the pages' width is 1200px.

Window.Name

WindowName.Name

Example:
vstring = Window1.Name

Alternative Example:
vstring = Project.Page("Window1").Name
vstring = Context.Window.Name

This returns the name of the specified Window.
The first example shows how to use it with a string variable named "vstring".

You could also write it into a Widget, e.g. a Label via the script: Label1.Text = Window1.Name
or simply display it in the Debug Logger: DebugMessage(Window1.Name)

In return, you can also assign a name to change the current one:
Window.Name = "otherName"

Window.PageName

WindowName.PageName

Example:
vstring = Window1.PageName

Alternative Example:
vstring = Project.Page("Window1").PageName
vstring = Context.Window.PageName

This returns the page name of the specified Window.
The first example shows how to use it with a string variable named "vstring".

You could also write it into a Widget, e.g. a Label via the script: Label1.Text = Window1.PageName
or simply display it in the Debug Logger: DebugMessage(Window1.PageName)

In return, you can also assign a page name to navigate to it:
Window1.PageName = "Page2"

When a Group Value (available in in the WD Unlimited Edition only) is applied to a Window, clients can access pages independent from each other. Per default the Group Value is set to "None" and the pages are synchronized.
With this variation the page change happens only on the client that executed the command:
Context.Window.PageName = "Page2"

Page and Window Members

Page and Window Members

Page and Window Members