InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IShowHideFieldActionData Class Referenceabstract

#include <IShowHideFieldActionData.h>

Inheritance diagram for IShowHideFieldActionData:
IBehaviorDataIPMUnknown

Public Types

enum  ActionConstants { kHide = 0, kShow, kNone }
 
typedef int32 Action
 
- Public Types inherited from IBehaviorData
enum  { kDefaultIID = IID_IBEHAVIORDATA }
 

Public Member Functions

virtual void SetFields (const K2Vector< K2Pair< UID, Action > > &fields)=0
 
virtual K2Vector< K2Pair< UID,
Action > > 
GetFields () const =0
 
- Public Member Functions inherited from IBehaviorData
virtual int32 GetAction () const =0
 
virtual PMString GetName () const =0
 
virtual UID GetOwner () const =0
 
virtual void SetOwner (const UID &owner)=0
 
virtual bool16 IsEnabled () const =0
 
virtual bool16 Enable (const bool16 &enable=kTrue)=0
 
bool16 IsDisabled () const
 
bool16 Disable ()
 
virtual void Copy (IPMUnknown *srcData)=0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

Data interface for Show Hide Field Behavior

See Also
INamedPageItemList (for a way of getting candidates for SetFields()

Member Function Documentation

virtual K2Vector< K2Pair<UID, Action> > IShowHideFieldActionData::GetFields () const
pure virtual

Get the fields to show or hide

Returns
A list of fields to show or hide. First item in pair is UID for field, second is whether to show, hide or do nothing to the the field.
virtual void IShowHideFieldActionData::SetFields (const K2Vector< K2Pair< UID, Action > > & fields)
pure virtual

Set the fields to show or hide

Parameters
fieldsa list of fields to show or hide. First item in pair is UID for field, second is whether to show, hide or do nothing to the the field.