InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Types | Public Member Functions | List of all members
ITextControlData Class Referenceabstract
Inheritance diagram for ITextControlData:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_ITEXTCONTROLDATA }
 
enum  TextControlDataState { kDirty = 1 }
 

Public Member Functions

virtual void SetString (const PMString &newString, bool16 invalidate=kTrue, bool16 notifyOfChange=kTrue, bool16 isGoodString=kTrue)=0
 
virtual const PMString & GetString () const =0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknown * QueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Member Enumeration Documentation

enum ITextControlData::TextControlDataState

Used after setting the string data

Member Function Documentation

virtual const PMString& ITextControlData::GetString () const
pure virtual

Get the value of the string

Returns
PMString of current string on interface.
virtual void ITextControlData::SetString (const PMString & newString,
bool16 invalidate = kTrue,
bool16 notifyOfChange = kTrue,
bool16 isGoodString = kTrue 
)
pure virtual

Method to set the string on interface.

Parameters
newStringstring to set
invalidatespecifies whether the control should be redrawn
notifyOfChangespecifies whether observers on the control data should be notified of the change.
isGoodStringspecifies whether newString is a valid string. Currently it is only used in EditboxTextControlData. If true, the last good text will be set automatically.