PageNumberStamp

Огляд

PageNumberStamp є клас в Aspose.PDF FOSS для Java. Наследники від: TextStamp.

Представляє марку з номерами сторінок, яка відображає поточний номер сторінки та загальну кількість сторів на кожній сторінці PDF-документу.

Цей клас надає 53 методи для роботи з об’єктами PageNumberStamp в програмах Java. Доступні методи включають: PageNumberStamp, TextStamp, formatPageNumber, getBottomMargin, getFormat, getHeight, getHorizontalAlignment, getLeftMargin, getOpacity, getRightMargin, getRotate, getRotateAngle, і 40 додаткових методів. Всі публічні члени доступні будь-якій додаткові Java після встановлення FOSS для пакету Java. Свойства: background, bottomMargin, format, height, horizontalAlignment, leftMargin, і ще 18 .

Властивості

Name	Type	Access	Description
`format`	`String`	Read	Повертає ряд форматизації для номера сторінки.
`startingNumber`	`int`	Read	Повертає номер початкової сторінки.
`value`	`String`	Read	Повертає текст цього штампу.
`textState`	`TextState`	Read	Повертає текст для цієї марки, створюючи її м’яко в разі необхідності.
`wordWrapMode`	`TextFormattingOptions.WordWrapMode`	Read	Повертає слово “wrap” для тексту цієї марки.
`textAlignment`	`HorizontalAlignment`	Read	Повертає текст, що знаходиться в зоні штампу.
`xIndent`	`double`	Read	Повертає горизонтальне положення (раздел X) штампу в точках.
`yIndent`	`double`	Read	Повертає вертикальне положення (Y-різок) штампу в точках.
`width`	`double`	Read	Повертає ширину площі штампу в точках.
`height`	`double`	Read	Повертає висоту площі штампу в точках.
`background`	`boolean`	Read	Повертає, чи відображається цей штамп за змістом сторінки.
`rotate`	`Rotation`	Read	Повертає число обертання для цієї марки.
`rotateAngle`	`double`	Read	Повертає кут обертання штампу в градусах.
`opacity`	`double`	Read	Повертає непрозорість (прозорість) штампу.
`horizontalAlignment`	`HorizontalAlignment`	Read	Повертає горизонтальне вирівнювання штампу на сторінці.
`verticalAlignment`	`VerticalAlignment`	Read	Повертає вертикальне вирівнювання штампу на сторінці.
`leftMargin`	`double`	Read	Повертає лівий край штампу в точках.
`rightMargin`	`double`	Read	Повертає правий край штампу в точках.
`topMargin`	`double`	Read	Повертає верхній марж штампу в точках.
`bottomMargin`	`double`	Read	Повертає нижню маржу штампа в точках.
`stampId`	`int`	Read	Повертає ідентифікатор штампу.
`zoom`	`double`	Read	Повертає фактор з’єднання (масштабу) для штампу.
`zoomX`	`double`	Read	Повертає коефіцієнт горизонтального зум (масштаб) для штампу.
`zoomY`	`double`	Read	Повертає фактор вертикального зум (масштаб) для штампу.

Методи

Signature	Description
`PageNumberStamp()`	Створює новий PageNumberStamp з попереднім форматом “Сторінка # $ P”.
`PageNumberStamp(format: String)`	Створює новий PageNumberStamp з зазначеним форматом.
`getFormat()` → `String`	Повертає ряд форматизації для номера сторінки.
`setFormat(format: String)`	Налаштовує ряд форматизації для номера сторінки.
`getStartingNumber()` → `int`	Повертає номер початкової сторінки.
`setStartingNumber(startingNumber: int)`	Налаштовує номер початкової сторінки.
`formatPageNumber(pageIndex: int, totalPages: int)` → `String`	Формулює текст номера сторінки для даного індексу сторінок та загальної кількості сторів.
`TextStamp(value: String)`	Створює новий TextStamp з даним значенням тексту.
`getValue()` → `String`	Повертає текст цього штампу.
`setValue(value: String)`	Налаштовує зміст тексту цієї марки.
`getTextState()` → `TextState`	Повертає текст для цієї марки, створюючи її м’яко в разі необхідності.
`setTextState(textState: TextState)`	Налаштовує текст для цього штампу.
`getWordWrapMode()` → `TextFormattingOptions.WordWrapMode`	Повертає слово “wrap” для тексту цієї марки.
`setWordWrapMode(wordWrapMode: TextFormattingOptions.WordWrapMode)`	Налаштовує текст цього штампу в режимі “загорнути”.
`getTextAlignment()` → `HorizontalAlignment`	Повертає текст, що знаходиться в зоні штампу.
`setTextAlignment(textAlignment: HorizontalAlignment)`	Налаштовує вирівнювання тексту в зоні штампу.
`put(page: Page)`	Наносить цю печатку на дану сторінку.
`getXIndent()` → `double`	Повертає горизонтальне положення (раздел X) штампу в точках.
`setXIndent(xIndent: double)`	Назначає горизонтальне положення (раздел X) штампу в точках.
`getYIndent()` → `double`	Повертає вертикальне положення (Y-різок) штампу в точках.
`setYIndent(yIndent: double)`	Назначає вертикальне положення (Y-шлях) штампу в точках.
`getWidth()` → `double`	Повертає ширину площі штампу в точках.
`setWidth(width: double)`	Назначає ширину площі штампу в точках.
`getHeight()` → `double`	Повертає висоту площі штампу в точках.
`setHeight(height: double)`	Назначає висоту площі штампу в точках.
`isBackground()` → `boolean`	Повертає, чи відображається цей штамп за змістом сторінки.
`setBackground(background: boolean)`	Налаштовує, чи відображається цей штамп за змістом сторінки.
`getRotate()` → `Rotation`	Повертає число обертання для цієї марки.
`setRotate(rotate: Rotation)`	Налаштовує обертання за допомогою enum {@link Rotation}.
`getRotateAngle()` → `double`	Повертає кут обертання штампу в градусах.
`setRotateAngle(rotateAngle: double)`	Налаштовує кут обертання штампу в градусах.
`getOpacity()` → `double`	Повертає непрозорість (прозорість) штампу.
`setOpacity(opacity: double)`	Налаштовує непрозорість (прозорість) штампу.
`getHorizontalAlignment()` → `HorizontalAlignment`	Повертає горизонтальне вирівнювання штампу на сторінці.
`setHorizontalAlignment(horizontalAlignment: HorizontalAlignment)`	Налаштовує горизонтальне вирівнювання штампу на сторінці.
`getVerticalAlignment()` → `VerticalAlignment`	Повертає вертикальне вирівнювання штампу на сторінці.
`setVerticalAlignment(verticalAlignment: VerticalAlignment)`	Налаштовує вертикальне вирівнювання штампу на сторінці.
`getLeftMargin()` → `double`	Повертає лівий край штампу в точках.
`setLeftMargin(leftMargin: double)`	Назначає лівий край штампу в точках.
`getRightMargin()` → `double`	Повертає правий край штампу в точках.
`setRightMargin(rightMargin: double)`	Назначає правий край штампу в точках.
`getTopMargin()` → `double`	Повертає верхній марж штампу в точках.
`setTopMargin(topMargin: double)`	Назначає верхній край марки в точках.
`getBottomMargin()` → `double`	Повертає нижню маржу штампа в точках.
`setBottomMargin(bottomMargin: double)`	Назначає нижній край штампу в точках.
`getStampId()` → `int`	Повертає ідентифікатор штампу.
`setStampId(stampId: int)`	Налаштовує ідентифікатор штампу.
`getZoom()` → `double`	Повертає фактор з’єднання (масштабу) для штампу.
`setZoom(zoom: double)`	Налаштовує фактор з’єднання (масштабу) для штампу.
`getZoomX()` → `double`	Повертає коефіцієнт горизонтального зум (масштаб) для штампу.
`setZoomX(zoomX: double)`	Налаштовує фактор горизонтального з’єднання (масштабу) для штампу.
`getZoomY()` → `double`	Повертає фактор вертикального зум (масштаб) для штампу.
`setZoomY(zoomY: double)`	Налаштовує фактор вертикального зум (масштабу) для штампу.

Дивіться також

Aspose.PDF for Java — Enterprise API Reference