Aspose.PDF FOSS для C++

API reference для Aspose.Pdf FOSS для C++ v1.0.0. 244 публичных типа, организованных по модулям.

Основной API

КлассОписание:
ArtifactКласс с 14 методами.
ArtifactCollectionКласс с 7 методами и 1 свойством.
BaseParagraphКласс с 23 методами и 1 свойством.
BitmapInfoBitmapInfo позволяет создавать необработанные bitmap-изображения с указанным форматом пикселей, шириной, высотой и данными пикселей, поддерживая работу с изображениями без внешних зависимостей.
BmpDeviceКласс с 1 методом.
BorderInfoКласс с 10 методами.
CellКласс с 27 методами.
CellsКласс с 9 методами.
ColorКласс с 147 методами.
DeviceБазовый класс Device предоставляет виртуальный деструктор, обеспечивая правильную очистку производных объектов растровых устройств, таких как PngDevice или JpegDevice.
DocumentМетаданные документа можно прочитать с помощью Document.Info() и методов доступа Title(), Author(), Creator(), Producer(), Subject() и Keywords().
DocumentDeviceКласс с 4 методами.
DocumentInfoКласс с 24 методами и 1 свойством.
DocumentPrivilegeКласс с 34 методами.
EmbeddedFileCollectionКласс с 9 методами.
FileSpecificationFileSpecification объекты позволяют задавать метаданные для встроенных файлов, включая MIME-тип, описание, имя Unicode и сжатие через свойство Encoding.
FloatingBoxКласс с 12 методами.
FontКласс Font позволяет разработчикам проверять, встроен ли шрифт в PDF и является ли он подмножеством, что позволяет выполнять проверки соответствия для PDF/A.
FontRepositoryКласс с 2 методами.
GraphInfoКласс с 25 методами.
HyperlinkКласс с 6 методами и 1 свойством.
ImageDeviceКласс с 10 методами.
JpegDeviceКласс с 1 методом.
LoadOptionsКласс с 3 методами.
MarginInfoMarginInfo обеспечивает точный контроль полей страницы с геттерами и сеттерами двойной точности для значений слева, справа, сверху и снизу.
MarginsКласс с 8 методами.
MetadataКласс Metadata реализует интерфейс, похожий на словарь, с методами Add(key, value), Remove(key) и TryGetValue(key, value) для управления записями XMP-metadata.
NamedDestinationCollectionКласс с 6 методами и 1 свойством.
OutlineCollectionКласс в Pdf CPP API.
OutlineItemCollectionКласс с 18 методами.
OutlinesКласс с 12 методами.
PageМетки страниц (например, римские цифры, пользовательские префиксы) управляются через классы PageLabel и PageLabelCollection.
PageCollectionКласс PageCollection предоставляет методы для добавления новой пустой страницы, вставки страницы в определённую позицию и удаления страниц по номеру или диапазону.
PageDevicePageDevice.Process(page, outputFileName) может отобразить страницу напрямую в путь к файлу.
PageLabelPageLabel.StartingValue() получает или задаёт числовой старт для последовательности меток страниц.
PageLabelCollectionPageLabelCollection.GetLabel(pageIndex) извлекает PageLabel, назначенный конкретной странице.
PageSizePageSize.Width() и Height() получают или задают размеры страницы, в то время как IsLandscape() указывает ориентацию.
ParagraphsКласс с 6 методами.
PngDeviceКласс с 3 методами.
PointКласс с 6 методами.
PositionКласс Position предоставляет геттеры и сеттеры XIndent и YIndent для точной настройки горизонтального и вертикального смещения аннотаций.
Rectangle-Aspose_PdfКласс с 28 методами.
RenderingOptionsКласс с 26 методами.
ResolutionResolution хранит горизонтальное и вертикальное DPI с помощью геттеров и сеттеров X() и Y().
ResourcesКласс с 3 методами и 1 свойством.
RowКласс с 23 методами.
RowsКлассы Rows и Row предоставляют модель таблицы для создания PDF‑таблиц с индивидуальным стилизованием ячеек, границами и отступами.
SvgLoadOptionsSvgLoadOptions позволяет импортировать SVG‑файлы с необязательной настройкой размера страницы через свойство AdjustPageSize.
TableКласс Table позволяет разработчикам создавать PDF-таблицы с полным контролем над строками, шириной столбцов, границами, отступами ячеек и состоянием текста по умолчанию.
TextAbsorberКласс с 6 методами и 1 свойством.
TextBuilderКласс с 2 методами.
TextDeviceКласс с 3 методами.
TextFragmentКласс с 7 методами.
TextFragmentAbsorberКласс с 4 методами.
TextFragmentCollectionКласс с 2 методами.
TextFragmentStateКласс с 1 методом.
TextParagraphКласс с 18 методами.
TextStateКласс TextState предоставляет геттеры и сеттеры для шрифта, размера шрифта, цветов переднего плана/фона/обводки, а также текстовых украшений, таких как подчёркивание, зачеркивание, подстрочный и надстрочный индексы.
TiffDeviceКласс с 11 методами.
TiffSettingsКласс с 13 методами.
WatermarkArtifactКласс в Pdf CPP API.
XImageXImage раскрывает пиксельные размеры изображения через методы Width() и Height().
XImageCollectionXImageCollection управляет несколькими объектами XImage, предоставляя операции Add, Replace, Delete и Clear.
XmpValueXmpValue предоставляет вспомогательные функции преобразования: ToString(), ToInteger(), ToDouble(), ToArray(), а также методы запроса типа, такие как IsString() и IsArray().

Перечисления

ПеречислениеОписание:
AFRelationshipПеречисление с 7 членами.
BorderSideEnum с 7 элементами.
ColorDepthEnum с 5 элементами.
CompressionTypeEnum с 5 элементами.
CryptoAlgorithmEnum с 4 элементами.
FileEncodingПеречисление с 2 элементами.
FormPresentationModeПеречисление с 2 элементами.
HorizontalAlignmentПеречисление с 6 элементами.
NumberingStyleПеречисление с 6 элементами.
PageCoordinateTypePageCoordinateType значения перечисления MediaBox и CropBox позволяют разработчикам выбирать, какой прямоугольник страницы использовать для вычислений координат.
PasswordTypeПеречисление с 4 элементами.
PdfFormatПеречисление с 27 элементами.
PermissionsПеречисление с 8 элементами.
RotationПеречисление Rotation предоставляет четыре значения ориентации: None, on90, on180, on270.
ShapeTypeПеречисление с 3 элементами.
VerticalAlignmentПеречисление с 4 элементами.

Аннотации

КлассОписание:
AnnotationКласс с 36 методами.
AnnotationCollectionКласс с 11 методами.
AnnotationSelectorКласс с 35 методами и 1 свойством.
BleedMarkAnnotationBleedMarkAnnotation.Accept(visitor) реализует паттерн «посетитель», позволяя внешним объектам-посетителям обрабатывать аннотацию, не раскрывая её внутреннюю структуру.
BorderВнешний вид границы можно настроить, задав её Width, Style, Effect, EffectIntensity и радиусы скругления углов с помощью методов класса Border.
CaretAnnotationКласс с 5 методами.
CharacteristicsКласс с 3 методами.
CircleAnnotationКласс с 1 методом.
ColorBarAnnotationКласс с 3 методами.
CommonFigureAnnotationКласс с 5 методами.
CornerPrinterMarkAnnotationКласс с 2 методами.
DefaultAppearanceКласс с 8 методами.
ExplicitDestinationКласс с 3 методами.
FileAttachmentAnnotationFileAttachmentAnnotation.File() получает или задает вложенный файл через объект FileSpecification, позволяя встраивать внешние ресурсы в PDF.
FitBExplicitDestinationКласс с 1 методом.
FitBHExplicitDestinationКласс с 2 методами.
FitBVExplicitDestinationКласс с 2 методами.
FitExplicitDestinationКласс с 1 методом.
FitHExplicitDestinationКласс с 2 методами.
FitRExplicitDestinationКласс с 5 методами.
FitVExplicitDestinationКласс с 2 методами.
FreeTextAnnotationКласс с 23 методами.
GoToActionКласс с 4 методами.
GoToURIActionКласс с 4 методами.
HighlightAnnotationКласс с 1 методом.
InkAnnotationInkAnnotation представляет свободные чернильные штрихи; его свойство InkList содержит StrokeList, которое можно прочитать или заменить.
JavascriptActionJavascriptAction инкапсулирует JavaScript фрагмент, прикреплённый к объектам PDF; скрипт можно получить или обновить с помощью геттера/сеттера Script().
LineAnnotationКласс с 25 методами.
LinkAnnotationLinkAnnotation позволяет создавать кликабельные области в PDF, которые могут вызывать PdfAction или переходить к именованному назначению.
MarkupAnnotationMarkupAnnotation предоставляет методы для установки состояния обзора, непрозрачности, заголовка и форматированного текста для аннотаций типа комментарий.
MovieAnnotationMovieAnnotation позволяет встраивать видеофайл в PDF, с параметрами для заголовка, флага постера, соотношения сторон и поворота.
NamedActionКласс с 3 методами.
NamedDestinationКласс с 2 методами.
PageInformationAnnotationКласс с 1 методом.
PdfActionPdfAction.GetECMAScriptString() возвращает JavaScript код, прикреплённый к действию PDF, позволяя просматривать или изменять интерактивные скрипты.
PolyAnnotationКласс с 11 методами.
PolygonAnnotationКласс с 1 методом.
PolylineAnnotationКласс с 1 методом.
PopupAnnotationКласс с 5 методами.
PrinterMarkAnnotationPrinterMarkAnnotation может вставлять печатные метки, такие как trim, bleed, registration или colour bars, во весь документ или на отдельную страницу через AddPrinterMarks.
RedactionAnnotationRedactionAnnotation позволяет постоянно удалять содержимое, при этом опционально накладывая пользовательский текст, цвет заливки, цвет границы и размер шрифта.
RegistrationMarkAnnotationКласс с 3 методами.
RichMediaAnnotationRichMediaAnnotation позволяет встраивать Flash или другие интерактивные медиа с событиями активации и пользовательскими переменными.
ScreenAnnotationКласс с 3 методами.
SoundAnnotationКласс с 3 методами.
SquareAnnotationКласс с 1 методом.
SquigglyAnnotationКласс с 1 методом.
StampAnnotationКласс с 5 методами.
StrikeOutAnnotationКласс с 1 методом.
SubmitFormActionКласс с 5 методами.
TextAnnotationКласс с 5 методами.
TextMarkupAnnotationКласс с 4 методами.
TextStyleКласс с 9 методами.
TrimMarkAnnotationTrimMarkAnnotation и UnderlineAnnotation оба поддерживают паттерн посетитель через метод Accept, который передаёт аннотацию объекту-посетителю.
UnderlineAnnotationКласс с 1 методом.
WatermarkAnnotationWatermarkAnnotation позволяет добавить визуальный водяной знак на страницу PDF и дает разработчикам возможность управлять его прозрачностью.
WidgetAnnotationWidgetAnnotation предоставляет доступ к атрибутам поля AcroForm, таким как ReadOnly, Required, Exportable и DefaultAppearance.
XYZExplicitDestinationXYZExplicitDestination предоставляет явные координаты просмотра страницы с помощью методов Left(), Top() и Zoom().

Перечисления

ПеречислениеОписание:
AnnotationFlagsПеречисление AnnotationFlags включает флаг Locked, который, когда установлен, предотвращает дальнейшие изменения свойств аннотации.
AnnotationStateПеречисление с 7 элементами.
AnnotationStateModelEnum с 3 элементами.
AnnotationTypeEnum с 33 элементами.
BorderEffectEnum с 2 элементами.
BorderStyleEnum с 5 элементами.
CapStyleПеречисление с 2 членами.
CaptionPositionПеречисление с 2 членами.
CaretSymbolПеречисление с 2 членами.
ColorsOfCMYKПеречисление с 4 членами.
ExplicitDestinationTypeEnum с 8 членами.
FileIconEnum с 4 членами.
FreeTextIntentEnum с 4 членами.
HighlightingModeEnum с 5 членами.
JustificationEnum с 3 элементами.
LineEndingEnum с 10 элементами.
LineIntentEnum с 3 элементами.
PolyIntentEnum с 4 элементами.
PredefinedActionПеречисление с 71 элементами.
PrinterMarkCornerPositionПеречисление с 4 элементами.
PrinterMarkSidePositionПеречисление с 4 элементами.
PrinterMarksKindПеречисление с 7 элементами.
ReplyTypeReplyType enum различает категории ответов Reply, Group и Undefined.
RichTextFontStylesEnum с 4 элементами.
SoundIconEnum с 2 элементами.
StampIconEnum с 14 элементами.
TextAlignmentEnum с 3 элементами.
TextIconEnum с 15 членами.

Drawing

КлассОписание:
CircleClass с 7 методами.
EllipseClass с 9 методами.
GraphClass с 16 методами.
LineКласс с 3 методами.
Rectangle-Aspose_Pdf_DrawingКласс с 11 методами.
ShapeКласс с 4 методами.

Facades

КлассОписание:
AlignmentTypeКласс с 4 методами.
BookmarkКласс с 35 методами.
BookmarksЗакладки можно организовать иерархически; используйте Bookmark.ChildItem() или Bookmark.ChildItems() для доступа к вложенным закладкам и установки свойств, таких как Action, Destination, и флагов отображения, таких как BoldFlag и ItalicFlag.
FacadeПерегрузки Facade.BindPdf принимают либо строку пути к файлу (srcFile), либо существующий Aspose::Pdf::Document (srcDoc) для загрузки содержимого PDF.
FormEditorКласс с 53 методами.
FormFieldFacadeКласс с 30 методами и 26 свойствами.
PdfAnnotationEditorPdfAnnotationEditor может импортировать аннотации из файлов FDF или XFDF и уплощать их в содержимое страницы, удаляя интерактивные элементы.
PdfBookmarkEditorPdfBookmarkEditor.CreateBookmarkOfPage(title, pageNumber) добавляет новую закладку, указывающую на указанную страницу.
PdfContentEditorPdfContentEditor.ReplaceText(srcText, destText) ищет по всему документу и заменяет совпадающие строки, возвращая true, если выполнена хотя бы одна замена.
PdfConverterКласс с 37 методами.
PdfExtractorPdfExtractor извлекает текст, вызывая ExtractText() и затем GetText(outputFile), чтобы записать извлечённый чистый текст в файл.
PdfFileEditorКласс с 72 методами.
PdfFileInfoPdfFileInfo предоставляет геттеры и сеттеры для стандартных полей метаданных, таких как Author, Creator, а также пользовательских ключей через GetMetaInfo(name) и SetMetaInfo(name, value).
PdfFileSecurityКласс с 20 методами.
PdfFileSignatureКласс с 41 методами.
PdfFileStampКласс с 26 методами и 8 свойствами.
PdfPageEditorКласс с 28 методами и 16 свойствами.
PdfXmpMetadataКласс с 15 методами.
SaveableFacadeSaveableFacade предлагает простой интерфейс для сохранения PDF-объектов в файловый путь с помощью Save(destFile).
SignatureNameSignatureName.HasSignature() возвращает true, если PDF содержит отдельную подпись PKCS#7, а ToString() предоставляет текстовое представление имени подписи.
VerticalAlignmentTypeVerticalAlignmentType предлагает статические фабричные методы Top(), Center() и Bottom() для получения объектов выравнивания, а ToString() — для получения их текстового представления.

Перечисления

ПеречислениеОписание:
AlgorithmEnum с 2 элементами.
AutoRotateModeПеречисление с 3 элементами.
BlendingColorSpaceПеречисление с 4 элементами.
DataTypeПеречисление с 6 элементами.
DefaultMetadataPropertiesПеречисление с 9 элементами.
EncodingTypeEnum с 7 членами.
FieldTypeEnum с 13 членами.
FontStyleEnum с 16 членами.
ImageMergeModeEnum с 3 членами.
KeySizeEnum с 3 членами.
PositioningModeEnum с 3 членами.
PropertyFlagEnum с 4 членами.
StampTypeEnum с 2 членами.
SubmitFormFlagПеречисление с 6 элементами.
WordWrapModeWordWrapMode enum определяет две стратегии переноса текста: Default и ByWords.

Forms

КлассОписание:
BarcodeFieldКласс с 6 методами.
ButtonFieldКласс с 11 методами.
CheckboxFieldКласс с 16 методами.
ChoiceFieldКласс с 14 методами.
ComboBoxFieldКласс с 5 методами.
DateFieldКласс с 4 методами.
DocMDPSignatureКласс с 1 методом.
ExternalSignatureКласс в Pdf CPP API.
FieldField.Recalculate() пересчитывает значение поля формы и возвращает true при успехе.
FileSelectBoxFieldКласс с 1 методом.
FormК полям текстовых полей формы можно программно добавить штрих-код, вызвав AddBarcode(code) у экземпляра TextBoxField.
IconFitIconFit позволяет осуществлять точный контроль масштабирования полей формы; разработчики могут задавать ScalingReason, ScalingMode и оставшиеся отступы перед рендерингом.
ListBoxFieldКласс с 3 методами.
NumberFieldКласс с 3 методами.
OptionКласс с 8 методами.
OptionCollectionКласс с 9 методами.
PKCS1Класс с 1 методом.
PKCS7Класс с 1 методом.
PKCS7DetachedКласс с 1 методом.
PasswordBoxFieldКласс с 1 методом.
RadioButtonFieldКласс с 7 методами.
RadioButtonOptionFieldКласс с 5 методами.
RichTextBoxFieldRichTextBoxField предоставляет поле формы, которое сохраняет форматированный текст со стилями, выравниванием и отформатированным значением.
SignatureОбъекты подписи позволяют создавать и проверять откреплённые подписи PKCS#7 в PDF-документах.
SignatureCustomAppearanceКласс с 37 методами.
SignatureFieldКласс с 2 методами.
TextBoxFieldКласс с 15 методами.
XFAXFA предоставляет доступ к XML‑based XFA form data; вызов FieldNames() возвращает список всех идентификаторов полей, присутствующих в документе XFA.

Перечисления

ПеречислениеОписание:
BoxStyleПеречисление с 6 элементами.
DocMDPAccessPermissionsПеречисление DocMDPAccessPermissions определяет разрешённые изменения в подписанном PDF: NoChanges предотвращает любые правки, FillingInForms позволяет заполнять формы и AnnotationModification разрешает изменения аннотаций.
FormTypeПеречисление с 3 элементами.
IconCaptionPositionПеречисление с 7 элементами.
ScalingModeScalingMode enum определяет опции пропорционального и аноморфного масштабирования для преобразования изображений.
ScalingReasonScalingReason enum указывает, когда следует применять масштабирование: Always, IconIsBigger, IconIsSmaller или Never.
SubjectNameElementsEnum с 7 элементами.
SymbologyEnum с 3 элементами.

См. также:

 Русский