Customizing the Layout of a Wizard

ACT provides you with the capability to customize the user interface of a non-AIM wizard, defining layouts both for the interface as a whole and for the individual interface components within the layout. Because the basic construction of an extension is described elsewhere, this section focuses solely on layout customizations.

Layout customizations are defined by the optional <uidefinition> block, which is placed inside the <extension> block in the XML definition file. The <uidefinition> block contains <layout> definitions, which contain child <component> blocks.

The basic definition of the <uidefinition> block follows:

  <uidefinition>
       <layout>
          <component/>
   	     <component/>
	        <component/>
   	     <component/>
       </layout>
  </uidefinition>

The customizations are exposed in a non-AIM wizard as follows:

User Interface Definition

The <uidefinition> block defines a single user interface (UI) for the wizard. It is the top-level entry that contains all layout definitions.

Layout Definition

The <layout> block defines a single custom layout within the UI definition for the wizard. A separate layout can be defined for each step in the wizard. The <layout> block contains all component definitions.

The <layout> block has the following attributes:

  • The attribute name defines the name of the layout. The name is referenced in a wizard step in the following format:

    LayoutName@ExtensionName

    This notation allows a wizard to reference a layout defined in a different extension.

Component Definition

The <component> block defines a single component of the wizard interface.

The <component> block has the following attributes:

  • The mandatory attribute name defines the name for the component.

    • The component name is required to position it next to another component. To do this, use the name in conjunction with the following attributes:

      • leftAttachment

      • rightAttachment

      • bottomAttachment

      • topAttachment

    • The component name is also used in the IronPython script with the method GetComponent(). For instance, in a step, the callback Onrefresh can use the following code:

      component = step.UserInterface.GetComponent(ComponentName)
  • The mandatory attribtues heightType, height, widthType, and width define the dimensions of the component. Possible values are as follows:

    • FitToContent: The component is to have a default size that is set by ACT. When selected, the attributes height and width become irrelevant.

    • Percentage: The height and width of the component is expressed as percentages.

    • Fixed: The height and width of the component is expressed in pixels.

  • The mandatory attribute componentType defines the type of component. Some examples of possible component types are:

    • startPageHeaderComponent (Defines banner titles)

    • propertiesComponent

    • chartComponent

    • tabularDataComponent

    • buttonsComponent

    • stepsListComponent

  • The attributes leftOffset, rightOffset, bottomOffset, and topOffset specify the distance and the margin between the different components.

  • The attributes customCSSFile, customHTMLFile, and customJSFile provide advanced capabilities to customize an entire component.

For an example of customizing a wizard interface, see Wizard Custom Layout Example.


Release 18.2 - © ANSYS, Inc. All rights reserved.