DR Developer's Guide
DR Interfaces | DR Methods | DR Types and Misc API

IMuiPropertyPageInstance

Interface ID: IID_IMuiPropertyPageInstance
Class ID: CID_IMuiPropertyPageInstance
Pointer type: PIMuiPropertyPageInstance
Inheritance: IMoaUnknown
Header file: muippage.h

Description

The IMuiPropertyPageInstance interface is a support interface for the IMuiPropertyPage interface, and represents the current state of the instantiated Property page generated from the VDL data provided by the Xtra or the data in the Xtra's VDL file in the props folder. Use the methods of the IMuiPropertyPageInstance interface to get or set the state or value of specific controls in the UpdateItem or ItemClicked methods of the IMuiPropertyPage interface.

You can use the SetControlProp and GetControlProp methods to set and retrieve the value of a control on the Property page. The developer passes in a symbol specifying a control to query and set, as well as a symbol identifying which control property they wish to set or receive.

Methods

GetControlProp() Retrieves the value of a particular property for all currently targeted objects.
SetControlProp() Sets the value for a particular property for all currently targeted objects.

GetControlProp()

Syntax
GetControlProp(MoaMmSymbol controlID, MoaMmSymbol property, MoaMmValue pResult)
Parameters
controlID
The MoaMmSymbol identifying the control to query. This symbol is specified in the VDL information provided by the Xtra, or in the Xtra's VDL file in the props folder.
property
The MoaMmSymbol identifying the property to retrieve. Predefined properties include: #value, #enabled, #visible, #range, #min and #max.
pResult
Returns the value of the requested control's property. If the #value property is requested, and the control state cannot be determined, pResult is of type void.
Returns
MoaError
Description
Call this method to retrieve the state/value information on the Property page for the specified property.

SetControlProp()

Syntax
SetControlProp(MoaMmSymbol controlID, MoaMmSymbol property, ConstPMoaMmValue pValue)
Parameters
controlID
The MoaMmSymbol identifying the control to be set. This symbol is specified in the VDL information provided by the Xtra, or in the Xtra's VDL file in the props folder.
property
The MoaMmSymbol identifying the property to retrieve. Predefined properties include: #value, #enabled, #visible, #range, #min and #max.
pValue
A pointer to the value of the property being set.
Returns
MoaError
Description
Call this method to set the state/value of a control on the Property page. This method is typically called from the UpdateItems method.

Copyright © 1995-2008 Adobe Macromedia Software LLC, Inc.