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

#include <IPageNumberPrefsCmdData.h>

Inheritance diagram for IPageNumberPrefsCmdData:
IPMUnknown

Public Member Functions

virtual void Set (const bool16 ordinalOn)=0
 
virtual const bool16 GetOrdinalNumbering () const =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

Command data interface for the page number prefs command to set the session preference relating how UI widgets display page numbers. This is a UI-only setting that doesn't affect how page number characters in text stories are computed/displayed.

See Also
kWorkspaceBoss
kSetPageNumberPrefsCmdCmdBoss
IPageNumberPrefs.h

Member Function Documentation

virtual const bool16 IPageNumberPrefsCmdData::GetOrdinalNumbering () const
pure virtual

Return the data member for ordinal numbering (kTrue) or standard/section numbering (kFalse)

Parameters
none
Returns
const bool16 the page numbering value
virtual void IPageNumberPrefsCmdData::Set (const bool16 ordinalOn)
pure virtual

Set the data member for ordinal numbering (kTrue) or standard/section numbering (kFalse) to use used for page number and page number range widget display. The UI control for this setting is in the general preferences dialog for InDesign.

Parameters
constbool16 ordinalOn kTrue for ordinal, kFalse for standard/section numbering (the default).