Softimage SDK Programmer's Guide > Customizing with the SDK > Custom Properties > Property Page Controls >

# Synoptic Widget

Synoptic controls pipe the contents of a synoptic view through an area on the property page. They are associated to an underlying string parameter which holds the full path to the synoptic file.

You create them using the PPGLayout.AddItem or PPGLayout::AddItem method with the siControlSynoptic control type enum:

    # ** during parameter definition (for example, in the Define callback) **
    # add string parameter for synoptic widget to a custom property and set
    # it to the location of the synoptic page
    oCustomProperty.AddParameter3( "SynWagon", c.siString, synfile )

    # ** during control creation (for example, in the DefineLayout callback) **
    # no convenience method for the synoptic widget control
    oLayout = oCustomProperty.PPGLayout
    oItem = oLayout.AddItem( "SynWagon", "", c.siControlSynoptic )
    oItem.SetAttribute( c.siUINoLabel, true )

Note

The size of the synoptic view determines the size of the control. For an example of the synoptic control, see the example.

The following item attributes are available:

Available on all Controls also as a property on the PPGItem object: | Common to many Controls:
--- | ---
siUILabel siUIItems siUIType siUIWidthPercentage siUILabelPercentage siUILabelMinPixels | siUINoLabel siUIValueOnly siUIContinue siUICX siUICY