PPG

Object Hierarchy | Related C++ Class: PPGEventContext

Introduced

4.0

Description

Represents an instance of a Property Page. This object can be manipulated within the event handling script code associated with a PPGLayout. (This event handling code is often called "SPDL logic" because in previous versions it could only be specified by putting script code directly in a spdl file.) This object is available to logic code as a global variable called "PPG". (For the purposes of backward compatibility it is also available via the global variable "PSet". It is also for reasons of backward compatibility that this object does not derive from Context and is available as a global variable rather than being passed as an argument to the callback routines).

There are two ways a Property Page can inspect multiple objects. In the first case, where the objects are of different types, there will actually be separate Property Page objects displayed within the same frame. In the second case, where the objects have the same type, multi-edit mode is used and a single instance of the PPG object may actually represent multiple objects. This is why the property PPG.Inspected returns an array rather than a single object.

This object provides shortcuts for direct access to the Parameters of the inspected object. For example, if a Property Page has a parameter named x then "PPG.x.Value = 10" is the VBScript code to change the value. In the case of multi-edit mode, this technique will only modify the first inspected object.

Note: The equivalent object in the C++ API is called PPGEventContext.

Methods

Close

Refresh

Properties

CurrentTab

Inspected

InspectedObjects

PPGLayout

See Also

PPGLayout.Logic

ProjectItem

Parameter

Context

InspectObj

Property Host Callbacks

 

 

Examples

• See PPG.1.js



Autodesk Softimage 2011