DocumentLevelNumbering Class

Relativity.Productions.API
Represents the document-level numbering scheme. The scheme allows you to generate a new document number for each document. The number is branded on the images in your production.
Inheritance Hierarchy

SystemObject
  Relativity.Productions.ServicesProductionNumberingBase
    Relativity.Productions.ServicesPageLevelNumbering
      Relativity.Productions.ServicesDocumentLevelNumbering

Namespace:  Relativity.Productions.Services
Assembly:  Relativity.Productions.Services.Interfaces (in Relativity.Productions.Services.Interfaces.dll) Version: 11.1.0.1 9c084404c128f715df772c7792aa49f21535523c
Syntax

public class DocumentLevelNumbering : PageLevelNumbering, 
	IDocumentPageNumberFields

The DocumentLevelNumbering type exposes the following members.

Constructors

  NameDescription
Public methodDocumentLevelNumbering
Creates a new instance of DocumentLevelNumbering.
Top
Properties

  NameDescription
Public propertyAttachmentRelationalField
The document field that holds the attachment relational number.
(Inherited from ProductionNumberingBase.)
Public propertyBatesPrefix
Bates prefix text.
(Inherited from PageLevelNumbering.)
Public propertyBatesStartNumber
Bates start number.
(Inherited from PageLevelNumbering.)
Public propertyBatesSuffix
Bates suffix text.
(Inherited from PageLevelNumbering.)
Public propertyDocumentNumberPageNumberSeparator
The separator between document and page numbers if IncludePageNumbers is set to true. Underscore, hyphen, and period are allowed characters.
Public propertyIncludePageNumbers
Specifies whether or not to include page numbers. If true, a unique number is added to each page following the document number.
Public propertyNumberingType
The document numbering type to be used. Valid values are defined by the NumberingType enum.
(Inherited from ProductionNumberingBase.)
Public propertyNumberOfDigitsForDocumentNumbering
The number of digits to be used for document level numbering. The range is from 1 to 7.
(Inherited from PageLevelNumbering.)
Public propertyNumberOfDigitsForPageNumbering
The number of digits for page numbering if IncludePageNumbers is set to true. The range is from 1 to 4.
Public propertyStartNumberingOnSecondPage
Whether or not to start page numbering on the second page of the document
Top
Methods

  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
See Also

Reference