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

#include <IPageRange.h>

Inheritance diagram for IPageRange:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IPAGERANGE }
 
enum  RangeFormat {
  kAllPages = 0, kUseRange, kBySection, kBySelection,
  kLastType = kBySelection
}
 

Public Member Functions

virtual void SetPageRangeFormat (RangeFormat format)=0
 
virtual void SetPageRange (PMString range)=0
 
virtual RangeFormat GetPageRangeFormat ()=0
 
virtual PMString GetPageRange ()=0
 
virtual void Copy (IPageRange *other)=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

Utility class to hold a page range.

Member Enumeration Documentation

anonymous enum

Default enum

Type of page range being held
Enumerator
kAllPages 

Ignore range string, use all pages of the document.

kUseRange 

Use range string. The string must be specified with ordinal page numbers.

kBySection 

By section option has been deprecated - do not use!

kBySelection 

Ignore range string, use spread with selected items in the document.

kLastType 

Placeholder

Member Function Documentation

virtual void IPageRange::Copy (IPageRangeother)
pure virtual

Copies one set of prefs into another

Parameters
otherIN The preferences to copy
virtual PMString IPageRange::GetPageRange ()
pure virtual

Get the page range string

Returns
PMString containing the page range string
virtual RangeFormat IPageRange::GetPageRangeFormat ()
pure virtual

Get the page range format being held

Returns
RangeFormat the page range format being held
virtual void IPageRange::SetPageRange (PMString range)
pure virtual

Set the page range string

Parameters
INPMString containing the page range
virtual void IPageRange::SetPageRangeFormat (RangeFormat format)
pure virtual

Set the page range format

Parameters
INRangeFormat the page range format being held