Relativity.Productions.Services.DocumentFieldNumbering

DocumentFieldNumbering

public class DocumentFieldNumbering : ProductionNumberingBase, IDocumentPageNumberFields

Represents the document field numbering scheme. The scheme allows you to use any fixed-length text field on the Document object for your numbering. For example, you could choose control number as the field and produce documents using the control number as the Bates field to maintain the original numbering of the documents.

Documentation

public string BatesPrefix { get; set; }

Bates prefix text.

public string BatesSuffix { get; set; }

Bates suffix text.

public string DocumentNumberPageNumberSeparator { get; set; }

The separator between document and page numbers if IncludePageNumbers is set to true. Underscore, hyphen, and period are allowed characters.

public bool IncludePageNumbers { get; set; }

Specifies whether or not to include page numbers. If true, a unique number is added to each page following the document number.

public FieldRef NumberingField { get; set; }

The document field that will be used as the Bates number.

public int NumberOfDigitsForPageNumbering { get; set; }

The number of digits for page numbering if IncludePageNumbers is set to true. The range is from 1 to 4.

public bool StartNumberingOnSecondPage { get; set; }

Whether or not to start page numbering on the second page of the document

public DocumentFieldNumbering()

Creates a new instance of DocumentFieldNumbering.