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 забезпечує віртуальний деструктор, гарантуючи правильне очищення похідних raster‑device об’єктів, таких як PngDevice або JpegDevice.
DocumentМетадані документа можна читати за допомогою Document.Info() та методів доступу Title(), Author(), Creator(), Producer(), Subject() та Keywords().
DocumentDeviceКлас з 4 методами.
DocumentInfoКлас з 24 методами та 1 властивістю.
DocumentPrivilegeКлас з 34 методами.
EmbeddedFileCollectionКлас з 9 методами.
FileSpecificationоб’єкти дозволяють встановлювати метадані для вбудованих файлів, включаючи MIME type, опис, 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.
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().

Перелік

ПерелікОпис
AFRelationshipEnum з 7 членами.
BorderSideEnum з 7 елементами.
ColorDepthEnum з 5 елементами.
CompressionTypeEnum з 5 елементами.
CryptoAlgorithmEnum з 4 елементами.
FileEncodingПерелічення з 2 членами.
FormPresentationModeПерелічення з 2 членами.
HorizontalAlignmentПерелічення з 6 членами.
NumberingStyleПерелічення з 6 членами.
PageCoordinateTypePageCoordinateType значення enum MediaBox і CropBox дозволяють розробникам вибирати, який прямокутник сторінки використовується для розрахунків координат.
PasswordTypeEnum з 4 елементами.
PdfFormatEnum з 27 елементами.
PermissionsEnum з 8 елементами.
RotationПеречислення Rotation надає чотири значення орієнтації: None, on90, on180, on270.
ShapeTypeEnum з 3 членами.
VerticalAlignmentEnum з 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 надає методи для встановлення стану огляду, прозорості, заголовка та форматованого тексту для анотацій типу comment‑type.
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 дозволяє назавжди видаляти вміст, при цьому за бажанням накладаючи власний текст, fill colour, border colour та font size.
RegistrationMarkAnnotationКлас з 3 методами.
RichMediaAnnotationRichMediaAnnotation дозволяє вбудовувати Flash або інші багаті медіа з activation events та custom variables.
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().

Перелік

ПерелікОпис
AnnotationFlagsAnnotationFlags enum включає прапорець Locked, який, коли встановлений, запобігає подальшим змінам властивостей анотації.
AnnotationStateEnum з 7 членами.
AnnotationStateModelПерелічення з 3 елементами.
AnnotationTypeПерелічення з 33 елементами.
BorderEffectПерелічення з 2 елементами.
BorderStyleПерелічення з 5 елементами.
CapStyleEnum з 2 елементами.
CaptionPositionEnum з 2 елементами.
CaretSymbolEnum з 2 елементами.
ColorsOfCMYKEnum з 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

КласОпис
CircleКлас з 7 методами.
EllipseКлас з 9 методами.
GraphКлас з 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() — для отримання їх текстового представлення.

Перелік

ПерелікОпис
AlgorithmПерелік з 2 членами.
AutoRotateModeEnum з 3 членами.
BlendingColorSpaceEnum з 4 членами.
DataTypeEnum з 6 членами.
DefaultMetadataPropertiesEnum з 9 членами.
EncodingTypeEnum з 7 членами.
FieldTypeEnum з 13 членами.
FontStyleEnum з 16 членами.
ImageMergeModeEnum з 3 членами.
KeySizeEnum з 3 елементами.
PositioningModeEnum з 3 елементами.
PropertyFlagEnum з 4 елементами.
StampTypeEnum з 2 елементами.
SubmitFormFlagEnum з 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 забезпечує доступ до даних форми XFA, заснованих на XML; виклик FieldNames() повертає список усіх ідентифікаторів полів, що містяться у документі XFA.

Перелік

ПерелікОпис
BoxStyleEnum з 6 членами.
DocMDPAccessPermissionsПерелічений DocMDPAccessPermissions enum визначає дозволені модифікації підписаного PDF: NoChanges запобігає будь-яким правкам, FillingInForms дозволяє заповнювати форми, і AnnotationModification дозволяє змінювати анотації.
FormTypeEnum з 3 елементами.
IconCaptionPositionEnum з 7 елементами.
ScalingModeScalingMode enum визначає пропорційні та анаморфні параметри масштабування для трансформацій зображень.
ScalingReasonScalingReason enum вказує, коли слід застосовувати масштабування: Завжди, IconIsBigger, IconIsSmaller або Ніколи.
SubjectNameElementsEnum з 7 елементами.
SymbologyEnum з 3 елементами.

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

 Українська