User Tools

Site Tools


DzGuidePage

Provides a script defined widget that participates in a widget stack.

More...

Inherits :

Methods

Detailed Description

Guide Pages are intended as a dynamic means of providing users with instructions on how to use a portion of the User Interface (UI), and/or provide widgets that simplify the process of getting started where an otherwise non-descript area of the UI would be displayed.

These pages are typically found within a DzPane via instances of filecontenttab_dz or productcontenttab_dz, or within an embedded instance of productassetsview_dz or associatedassetsview_dz.

Methods


String : defaultScriptPath()

Return Value:

  • The default path to the script to execute in order to create the UI in this page, sans extension.

See Also:

  • setUiscript()

Since:

  • 4.10.0.41

Boolean : isCurrentPage()

Return Value:

  • true if the page is the current widget in the stack, otherwise false.

void : makeCurrentPage( Boolean onOff )

Sets whether the guide page is the current widget in the stack.

Parameter(s):

  • onOff - If true, the guide page is set as the current widget, otherwise the other widget in the stack is raised.

DzError : reload()

Loads the contents of the page by calling the current script. A special script context is provided to this script which exposes a global “getWidget()” function that returns a DzWidget wrapper. This DzWidget can be used by the script to create, populate, and connect the UI components inside the widget.

Return Value:

  • DZ_NO_ERROR if no error is encountered, otherwise an appropriate error code.

See Also:

Since:

  • 4.10.0.41

String : scriptFilename()

Return Value:

  • The full path to the script to execute in order to create the UI in this page.

See Also:

Since:

  • 4.10.0.41

DzError : setUiScript( String scriptPath )

Loads the contents of the page by calling the script at scriptPath. A special script context is provided to this script which exposes a global “getWidget()” function that returns a DzWidget wrapper. This DzWidget can be used by the script to create, populate, and connect the UI components inside the widget.

Parameter(s):

  • scriptPath - The path to the script to execute in order to create the UI in this page. The path can be absolute, relative to the resources folder in the application data path, or relative to the application resources path. If the path does not include an extention, an attempt is made to locate a script with one of the possible extensions (in dsa, dsb, dse, ds order) at the specified path until one is found.

Return Value:

  • DZ_NO_ERROR if no error is encountered, otherwise an appropriate error code.

See Also: