fDocumentSequenceItem interface

This object defines a page sequence and the parameters controlling it. This represents the "pseq" keyword in the Document Sequence control stream and the values for the psequp / pseqstart processing instructions.

The possible values for fDocumentSequenceItem.startForce, to determine on which page the page sequence should start.

The StartForce enumeration has the following constants of type int.

Start this page sequence on the next available page, regardless of page number.

Start this page sequence on the next available even page, adding an extra blank page from the current page sequence if required.

Start this page sequence on the next available odd page, adding an extra blank page from the current page sequence if required.

The possible values for fDocumentSequenceItem.endForce, to determine on which page the page sequence should end.

The EndForce enumeration has the following constants of type int.

End this page sequence on the next available page, regardless of page number or number of pages created.

Force this page sequence to contain an even number of pages (not including any child sequences), adding an extra blank page from this page sequence if required.

Force this page sequence to contain an odd number of pages (not including any child sequences), adding an extra blank page from this page sequence if required.

Force this page sequence to contain a number of pages that is a multiple of the value stored in fDocumentSequenceItem.end, adding extra blank pages from this page sequence if required.

End this page sequence on the next available even page, adding an extra blank page from this page sequence if required.

End this page sequence on the next available odd page, adding an extra blank page from this page sequence if required.

End this page sequence on the next page where the page number is a multiple of the value stored in fDocumentSequenceItem.end, adding extra blank pages from this page sequence if required.

The possible values for fDocumentSequenceItem.initialPageNumber, to determine what the page number should be for the first page in the page sequence.

The InitialPageNumber enumeration has the following constants of type int.

The page number for the first page in this sequence should be set to 1 higher than the previous page number.

The page number for the first page in this sequence should be set to the next available odd number.

The page number for the first page in this sequence should be set to the next available even number.

The default height of the page to create, if not specified by the current page sequence.

The default width of the page to create, if not specified by the current page sequence.

Insert blank pages as required to ensure this page sequence meets the specified end condition as listed in fDocumentSequenceItem.EndForce. This condition is processed before the start condition of the next page sequence.

If the end condition is set to fDocumentSequenceItem.END_MULTIPLE, this property specifies the number of pages that the total page number should be a multiple of when ending this page sequence.

The separator to use when generating the text form of the page sequence page number.

The number of characters between each separator when generating the text form of the page sequence page number.

The id number for this instance of the page sequence. This value does not need to be unique, and is only used to identify it when accessing the page sequence state information during formatting.

The page number for the first page produced by this page sequence. If the value is positive, it will be set to that page number. Otherwise it should be one of the values available in fDocumentSequenceItem.DocumentSequenceItemInitial. No attempt is made to ensure these page numbers are unique, contiguous or kept in the standard left / right pairing.

The language associated with this instance of the page sequence.

The format sequence to use when generating the text form of the page sequence page number.

If true, an error will be raised if this instance of the page sequence gets selected. Otherwise, no errors are raised.

If true, any tests for odd or even pages when selecting items from the page sequence will be reversed, i.e. a rule that states a layer will be picked on an odd page will now only be picked on an even page and an even rule will be picked on an odd page.

The page sequence to process.

Insert blank pages as required to ensure this page sequence starts meets the specified start condition as listed in fDocumentSequenceItem.StartForce. This condition is processed after the end condition for the previous page sequence.

If true, any tests for odd or even pages when selecting items from the page sequence will be based on the absolute page number in the document, not the page sequence number.

Creates a new anonymous fDocumentSequenceItem object to use with fFormatting.startPageSequence()

fDocumentSequenceItem
Parameters	None
Returns	fDocumentSequenceItem. The newly created fDocumentSequenceItem object.

Return the object corresponding to the given serialized representation.

readResolveobj
Parameters	Objectobj The serialized representation.
Returns	fDocumentSequenceItem. The object corresponding to the serialized representation.

defaultPageHeight
Access	read-write
Returns	fLength

defaultPageWidth
Access	read-write
Returns	fLength

endMultiple
Access	read-write
Returns	int

formatSeparator
Access	read-write
Returns	String

formatSeparatorWidth
Access	read-write
Returns	int