Bates numbering (also called Bates stamping) is used to number and/or date/time stamp images and documents for future reference. Typically this would be done as and when images and documents are received.
This is mainly used by businesses for identifying receipts and orders and is used extensively by the legal profession when evidence/exhibits must be numbered during the "discovery stage" of preparations for legal action.
There is no standard format for a Bates number although it is common to use 8, 9 or 10 digit numbers with additional identifying text (usually a short identifying prefix or suffix). The Bates number can either uniquely identify every page of every document (with the Bates number incrementing with every page) or just uniquely identify every document (with the Bates number incrementing with every document).
I2PDF_BatesFormat | |
---|---|
Parameters: | format - text (up to 100 characters) with any combination of special formatting markup characters: |
Return Value: | 0 - success 1 - invalid format |
Notes: |
I2PDF_BatesLocation | |
---|---|
Parameters: | verticalPosition - must be one of the following: VERTICAL_ALIGNMENT_TOP (1), VERTICAL_ALIGNMENT_MIDDLE (2) or VERTICAL_ALIGNMENT_BOTTOM (3) horizontalPosition - must be one of the following: HORIZONTAL_ALIGNMENT_LEFT (1), HORIZONTAL_ALIGNMENT_CENTER (2) or HORIZONTAL_ALIGNMENT_RIGHT (3) textOrientation - must be one of the following: 0, 90, 180 or 270. margin - must be between 0.0 and 100.0 points inclusive (this is not used if the alignment is VERTICAL_ALIGNMENT_MIDDLE and HORIZONTAL_ALIGNMENT_CENTER). |
Return Value: | 0 - success 1 - invalid verticalPosition 2 - invalid horizontalPosition 3 - invalid textOrientation 4 - invalid margin |
Notes: |
I2PDF_BatesLocation_Int | |
---|---|
Parameters: | verticalPosition - must be one of the following: VERTICAL_ALIGNMENT_TOP (1), VERTICAL_ALIGNMENT_MIDDLE (2) or VERTICAL_ALIGNMENT_BOTTOM (3) horizontalPosition - must be one of the following: HORIZONTAL_ALIGNMENT_LEFT (1), HORIZONTAL_ALIGNMENT_CENTER (2) or HORIZONTAL_ALIGNMENT_RIGHT (3) textOrientation - must be one of the following: 0, 90, 180 or 270. margin - must be between 0 and 100 points inclusive (this is not used if the alignment is VERTICAL_ALIGNMENT_MIDDLE and HORIZONTAL_ALIGNMENT_CENTER). |
Return Value: | 0 - success 1 - invalid verticalPosition 2 - invalid horizontalPosition 3 - invalid textOrientation 4 - invalid margin |
Notes: |
I2PDF_BatesFont_Real | |
---|---|
Parameters: | size - must be between 1 and 300 points inclusive. font - must be one of the following standard PDF fonts (which are also known as base14 fonts): Courier, Courier-Bold, Courier-BoldOblique, Courier-Oblique, Helvetica, Helvetica-Bold, Helvetica-BoldOblique, Helvetica-Oblique, Times-Roman, Times-Bold, Times-Italic, Times-BoldItalic fillRed - specifies the red component of the fill color. Value must be between 0.0 and 1.0 inclusive. fillGreen - specifies the green component of the fill color. Value must be between 0.0 and 1.0 inclusive. fillBlue - specifies the blue component of the fill color. Value must be between 0.0 and 1.0 inclusive. style - must be one of the following: TEXT_STYLE_NORMAL (1) - text is filled in with the required fill color TEXT_STYLE_STROKE (2) - text is filled in with the required fill color and the outline of each letter is "stroked" in the other color otherRed - specifies the red component of the "other" color. Value must be between 0.0 and 1.0 inclusive. otherGreen - specifies the green component of "other" color. Value must be between 0.0 and 1.0 inclusive. otherBlue - specifies the blue component of "other" color. Value must be between 0.0 and 1.0 inclusive. |
Return Value: | 0 - success 1 - invalid size 2 - invalid font 3 - invalid fillRed 4 - invalid fillGreen 5 - invalid fillBlue 6 - invalid style 7 - invalid otherRed 8 - invalid otherGreen 9 - invalid otherBlue |
Notes: |
I2PDF_BatesFont_Int | |
---|---|
Parameters: | size - must be between 1 and 300 points inclusive. font - must be one of the following standard PDF fonts (which are also known as base14 fonts): Courier, Courier-Bold, Courier-BoldOblique, Courier-Oblique, Helvetica, Helvetica-Bold, Helvetica-BoldOblique, Helvetica-Oblique, Times-Roman, Times-Bold, Times-Italic, Times-BoldItalic fillRed - specifies the red component of the fill color. Value must be between 0 and 255 inclusive. fillGreen - specifies the green component of the fill color. Value must be between 0 and 255 inclusive. fillBlue - specifies the blue component of the fill color. Value must be between 0 and 255 inclusive. style - must be one of the following: TEXT_STYLE_NORMAL (1) - text is filled in with the required fill color TEXT_STYLE_STROKE (2) - text is filled in with the required fill color and the outline of each letter is "stroked" in the other color otherRed - specifies the red component of the "other" color. Value must be between 0 and 255 inclusive. otherGreen - specifies the green component of "other" color. Value must be between 0 and 255 inclusive. otherBlue - specifies the blue component of "other" color. Value must be between 0 and 255 inclusive. |
Return Value: | 0 - success 1 - invalid size 2 - invalid font 3 - invalid fillRed 4 - invalid fillGreen 5 - invalid fillBlue 6 - invalid style 7 - invalid otherRed 8 - invalid otherGreen 9 - invalid otherBlue |
Notes: |
I2PDF_BatesFont_Web | |
---|---|
Parameters: | size - must be between 1 and 300 points inclusive. font - must be one of the following standard PDF fonts (which are also known as base14 fonts): Courier, Courier-Bold, Courier-BoldOblique, Courier-Oblique, Helvetica, Helvetica-Bold, Helvetica-BoldOblique, Helvetica-Oblique, Times-Roman, Times-Bold, Times-Italic, Times-BoldItalic fillColor - specified as a hexadecimal string (from #000000 to #FFFFFF) style - must be one of the following: TEXT_STYLE_NORMAL (1) - text is filled in with the required fill color TEXT_STYLE_STROKE (2) - text is filled in with the required fill color and the outline of each letter is "stroked" in the other color otherColor - specified as a hexadecimal string (from #000000 to #FFFFFF) |
Return Value: | 0 - success 1 - invalid size 2 - invalid font 3 - invalid fillColor 4 - invalid style 5 - invalid otherColor |
Notes: |
I2PDF_BatesFile | |
---|---|
Parameters: | filename - specifies the name and location of the file to store the Bates number in. |
Return Value: | 0 - success 1 - invalid filename |
Notes: |
I2PDF_BatesNumber | |
---|---|
Parameters: | value - must be a value between 0 and 4294967295 inclusive. |
Return Value: | 0 - success |
Notes: |
I2PDF_BatesIncrement | |
---|---|
Parameters: | value - must be between 0 and 1000000. |
Return Value: | 0 - success 1 - invalid value |
Notes: |
I2PDF_BatesBackground_Real | |
---|---|
Parameters: | shape - must be one of the following: BATES_BACKGROUND_FILLED_RECT (1) or BATES_BACKGROUND_OUTLINE_RECT (2). backgroundRed - specifies the red component of the background color. Value must be between 0.0 and 1.0 inclusive. backgroundGreen - specifies the green component of the background color. Value must be between 0.0 and 1.0 inclusive. backgroundBlue - specifies the blue component of the background color. Value must be between 0.0 and 1.0 inclusive. borderRed - specifies the red component of the border color. Value must be between 0.0 and 1.0 inclusive. borderGreen - specifies the green component of the border color. Value must be between 0.0 and 1.0 inclusive. borderBlue - specifies the blue component of the border color. Value must be between 0.0 and 1.0 inclusive. |
Return Value: | 0 - success 1 - invalid shape 2 - invalid backgroundRed 3 - invalid backgroundGreen 4 - invalid backgroundBlue 5 - invalid borderRed 6 - invalid borderGreen 7 - invalid borderBlue |
Notes: |
I2PDF_BatesBackground_Int | |
---|---|
Parameters: | shape - must be one of the following: BATES_BACKGROUND_FILLED_RECT (1) or BATES_BACKGROUND_OUTLINE_RECT (2). backgroundRed - specifies the red component of the background color. Value must be between 0 and 255 inclusive. backgroundGreen - specifies the green component of the background color. Value must be between 0 and 255 inclusive. backgroundBlue - specifies the blue component of the background color. Value must be between 0 and 255 inclusive. borderRed - specifies the red component of the border color. Value must be between 0 and 255 inclusive. borderGreen - specifies the green component of the border color. Value must be between 0 and 255 inclusive. borderBlue - specifies the blue component of the border color. Value must be between 0 and 255 inclusive. |
Return Value: | 0 - success 1 - invalid shape 2 - invalid backgroundRed 3 - invalid backgroundGreen 4 - invalid backgroundBlue 5 - invalid borderRed 6 - invalid borderGreen 7 - invalid borderBlue |
Notes: |
I2PDF_BatesBackground_Web | |
---|---|
Parameters: | shape - must be one of the following: BATES_BACKGROUND_FILLED_RECT (1) or BATES_BACKGROUND_OUTLINE_RECT (2). backgroundColor - specified as a hexadecimal string (from #000000 to #FFFFFF) borderColor - specified as a hexadecimal string (from #000000 to #FFFFFF) |
Return Value: | 0 - success 1 - invalid shape 2 - invalid backgroundColor 3 - invalid borderColor |
Notes: |