DefineLayout

Description

Defines the layout of controls on a property page (including a property page defined for a custom operator).

Use this callback to define how the property page will appear. This is where you define the controls (such as buttons, tabs, text fields, and combo boxes) and the overall layout (such as where the lines break, the spacing between controls, and the width and alignment of controls).

This callback is fired immediately after the Define callback is fired for the first time in a Softimage session. You can also force it to fire when you use the PPG.Refresh method.

Applies To

Custom Operators

Custom Properties

Syntax

    // C#
    public class <plugin-item_name>
    {
       public bool DefineLayout( Context in_ctxt )
       {
           ...
       }
    }

    // C++
    CStatus <plugin-item_name>_DefineLayout( CRef& in_context )
    {
       ...
    }

    // JScript
    function <plugin-item_name>_DefineLayout( in_context )
    {
       ...
    }

    # Python
    def <plugin-item_name>_DefineLayout( in_context ):
       ...

    ' VBScript
    Function <plugin-item_name>_DefineLayout( in_context )
       ...
    End Function

    # PerlScript
    sub <plugin-item_name>_DefineLayout
    {
       my $in_context = shift;
    }

<plugin-item_name> is the name specified in the call to RegisterProperty or PluginRegistrar.RegisterOperator, with any spaces removed. For example, if you register a property with the name "My Property", the callback function names start with "MyProperty".

Parameters

Parameter | Language | Type | Description
in_context | Scripting and C# | Context | Context.Source returns the PPGLayout. There are no context attributes for this callback.
C++ | CRef & | A reference to the PPGLayout .

See Also

• Define

• Property Page Controls

• Setting Control Attributes

• Grouping Controls

• Wrapping Controls (Rows)

• Using Multiple Pages (Tabs)

• Property Callbacks

• Operator Callbacks

Autodesk Softimage v7.5