Aspose.PDF FOSS dla Go

API reference dla Aspose.Pdf FOSS dla Go. 206 publicznych typów uporządkowanych według modułu.

Podstawowe API

KlasaOpis
AIClientAIClient jest kontraktem, którego konsumuje każdy copilot: jedno wywołanie, jedno zakończenie czatu.
APIErrorAPIError jest zwracany, gdy punkt końcowy AI odpowiada statusem innym niż 2xx.
ActionAction jest wspólnym interfejsem implementowanym przez każdy konkretny typ akcji.
ActionTypeActionType określa rodzaj akcji dołączonej do adnotacji (zazwyczaj wpis /A LinkAnnotation).
AnnotationAnnotation jest wspólnym interfejsem implementowanym przez każdy konkretny typ adnotacji.
AnnotationCollectionAnnotationCollection jest żywym, uporządkowanym zestawem adnotacji dołączonych do jednej strony.
AnnotationTypeAnnotationType identyfikuje rodzaj adnotacji.
BmpDeviceBmpDevice renderuje stronę do BMP.
BookletBindingBookletBinding wybiera krawędź wiązania broszury.
BookletOptionsBookletOptions konfiguruje układ broszury.
BorderEffectBorderEffect kontroluje wpis /BE/S zgodnie z ISO 32000-1 §12.5.4 Tabela 167.
BorderInfoBorderInfo opisuje obramowanie rysowane wokół tabeli lub komórki.
BorderSideBorderSide jest maską bitową wybierającą, które strony prostokątnego obramowania są rysowane.
BorderStyleBorderStyle steruje słownikiem /BS służącym do rysowania adnotacji zgodnie z ISO 32000-1 §12.5.4 Tabela 168.
ButtonAppearanceButtonAppearance konfiguruje bogaty wygląd przycisku push: oddzielne napisy dla stanów normal / rollover / down, opcjonalny obrazek ikony oraz face/border/text colours.
ButtonFieldButtonField jest przyciskiem — wyłącznie akcja, bez semantyki wartości.
ButtonIconPositionButtonIconPosition kontroluje sposób, w jaki przycisk układa swoją ikonę i podpis — wpis /MK /TP zgodnie z ISO 32000-1 §12.5.6.19 Tabela 189.
CaretAnnotationCaretAnnotation oznacza punkt wstawiania lub usunięcia tekstu, rysowany jako skierowany w górę znak wstawienia („^”) wypełniony kolorem adnotacji.
CaretSymbolCaretSymbol jest wpisem /Sy adnotacji Caret zgodnie z ISO 32000-1 §12.5.6.11 Tabela 180 — opcjonalny symbol rysowany razem ze znakiem wstawienia, aby powiązać go z akcją edycji.
CellKomórka jest pojedynczą komórką w wierszu.
CertifyPermissionCertifyPermission jest poziomem uprawnień DocMDP podpisu certyfikacyjnego (ISO 32000-1 §12.8.2.2 Tabela 254).
ChatCopilotChatCopilot odpowiada na pytania dotyczące dokumentu, zachowując historię konwersacji.
ChatOptionsChatOptions konfiguruje ChatCopilot.
CheckboxFieldCheckboxField jest polem wyboru ze stanem włącz/wyłącz.
ChoiceOptionChoiceOption jest jedną opcją ComboBoxField lub ListBoxField.
CircleAnnotationCircleAnnotation rysuje eliptyczną adnotację.
ColorKolor reprezentuje kolor RGBA z wartościami w przedziale [0, 1].
ComboBoxFieldComboBoxField jest polem wyboru rozwijanego typu single-select.
CompletionRequestCompletionRequest opisuje jedno wywołanie chat-completion.
CompletionResponseCompletionResponse jest odpowiedzią modelu.
DateFieldDateField jest polem tekstowym z akcją formatu daty JavaScript i maską formatu (np.
DestinationDestination jest wspólnym interfejsem dla wszystkich jawnych destynacji.
DestinationFitDestinationFit — [page /Fit].
DestinationFitBDestinationFitB — [page /FitB].
DestinationFitBHDestinationFitBH — [page /FitBH top].
DestinationFitBVDestinationFitBV — [strona /FitBV pozostało].
DestinationFitHDestinationFitH — [strona /FitH góra].
DestinationFitRDestinationFitR — [strona /FitR lewa dół prawa góra].
DestinationFitVDestinationFitV — [strona /FitV lewa].
DestinationTypeDestinationType identyfikuje docelowy smak.
DestinationXYZDestinationXYZ — [page /XYZ left top zoom].
DocumentDokument jest dokumentem PDF.
DocumentInfoDocumentInfo zawiera informacje o dokumencie pochodzące ze słownika PDF Info.
EmbeddedFileEmbeddedFile jest jednym załącznikiem: słownik /Filespec z osadzonym strumieniem.
EmbeddedFilesEmbeddedFiles jest zbiorą załączonych (osadzonych) plików dokumentu — drzewem nazw /Catalog/Names/EmbeddedFiles (ISO 32000-1 §7.11.4).
EncryptionAlgorithmEncryptionAlgorithm wybiera szyfr i wersję obsługi zabezpieczeń używaną przez (*Document).SetEncryption.
EncryptionOptionsEncryptionOptions grupuje wszystkie ustawienia, które kontrolują sposób szyfrowania dokumentu przy zapisywaniu.
FieldField jest wspólnym interfejsem implementowanym przez każdy konkretny typ pola formularza (TextBoxField, CheckboxField, RadioButtonField itp.).
FieldStyleFieldStyle to wizualny styl stosowany do widget(ów) pola formularza.
FigureAltFigureAlt to element struktury /Figure, który nie posiada tekstu alternatywnego, połączony z obrazem, który otacza (gdy da się rozwiązać).
FileAttachmentAnnotationFileAttachmentAnnotation osadza plik w dokumencie i wyświetla ikonę w /Rect adnotacji.
FileAttachmentIconFileAttachmentIcon nazwy zgodnie z ISO 32000-1 §12.5.6.15 Tabela 178.
FileSelectBoxFieldFileSelectBoxField jest polem tekstowym, którego wartość jest ścieżką do pliku (FileSelect flag), używanym do dołączania lokalnego pliku przy wysyłaniu.
FloatSideFloatSide wybiera, którą krawędź przytula się pływający element, gdy tekst owija się wokół niego.
FloatingBoxFloatingBox jest pozycjonowanym kontenerem treści (Poziom 2 modelu przepływu): pudełkiem z opcjonalną ramką, tłem i wypełnieniem, które układa swoją zawartość (akapity, nagłówki, obrazy, listy) wewnątrz swojej szerokości.
FlowFlow jest generatorem dokumentów, który układa treść od góry do dołu i automatycznie paginuje — odpowiednikiem „flow” do rysowania opartego na prostokątach API.
FlowOptionsFlowOptions konfiguruje Flow.
FontCzcionka jest implementowana przy użyciu standardowych 14 czcionek oraz osadzonych czcionek TTF.
FormFormularz jest widokiem AcroForm dokumentu.
FormFieldTypeFormFieldType identyfikuje rodzaj pola formularza.
FreeTextAnnotationFreeTextAnnotation wyświetla tekst bezpośrednio na stronie, renderowany do /AP/N przy użyciu wbudowanej czcionki.
FreeTextIntentFreeTextIntent zgodnie z ISO 32000-1 §12.5.6.6 wpisem /IT.
GenericAnnotationGenericAnnotation jest powierzchnią ogólną dla wartości /Subtype, które to wydanie jeszcze nie modeluje (Stamp, FreeText, Ink, itp.).
GifDeviceGifDevice renderuje stronę do GIF.
GoToActionGoToAction przechodzi do strony w tym samym dokumencie.
GoToURIActionGoToURIAction otwiera URI w domyślnym obsługującym użytkownika (zwykle przeglądarce internetowej).
GradientGradient jest wypełnieniem, które zmienia kolor wzdłuż kształtu: albo LinearGradient, albo RadialGradient.
GradientStopGradientStop jest jednym przystankiem koloru w gradiencie, umieszczonym na Offset (0 na początku gradientu, 1 na jego końcu).
HAlignHAlign określa poziome wyrównanie tekstu w obrębie prostokąta.
HTMLModeHTMLMode wybiera, jak SaveHTML / WriteHTML przedstawia tekst strony.
HTMLSaveOptionsHTMLSaveOptions konfiguruje SaveHTML / WriteHTML.
HighlightAnnotationHighlightAnnotation oznacza obszar półprzezroczystym kolorem podświetlenia.
ImageImage przechowuje wyodrębniony obraz wraz z zakodowanymi danymi i metadanymi.
ImageColorSpaceImageColorSpace opisuje oryginalną przestrzeń barw obrazu w PDF.
ImageDescriptionCopilotImageDescriptionCopilot opisuje obrazy przy użyciu modelu wizyjnego.
ImageDescriptionOptionsImageDescriptionOptions konfiguruje ImageDescriptionCopilot.
ImageFormatImageFormat opisuje format wyjściowy wyodrębnionego obrazu.
ImageInfoImageInfo przechowuje metadane obrazu znalezionego na stronie bez dekodowania danych pikseli.
ImageStampImageStamp nakłada obraz rastrowy (PNG lub JPEG), rozciągnięty, aby wypełnić Rect.
ImageToDocumentOptionsImageToDocumentOptions kontroluje rozmiar strony dla ImageToDocument.
InkAnnotationInkAnnotation rysuje serię swobodnych pociągnięć — zazwyczaj używanych do przedstawiania odręcznego tuszu.
JSONExportOptionsJSONExportOptions kontroluje (*Form).ExportJSON / WriteJSON.
JavaScriptActionJavaScriptAction przechowuje fragment JavaScript dołączony do adnotacji.
JavaScriptCollectionJavaScriptCollection jest magazynem JavaScript na poziomie dokumentu, opartym na drzewie nazw /Catalog/Names/JavaScript (ISO 32000-1 §7.7.4 / §8.5.1).
JpegDeviceJpegDevice renderuje stronę do formatu JPEG.
LLMOCREngineLLMOCREngine rozpoznaje tekst, wysyłając obraz strony do modelu czatu zdolnego do analizy wizualnej.
LLMOCROptionsLLMOCROptions konfiguruje silnik OCR modelu wizyjnego.
LayerWarstwa jest jedną Grupą Opcjonalnej Zawartości (OCG) w dokumencie.
LineAnnotationLineAnnotation rysuje prostą linię pomiędzy dwoma punktami, z opcjonalnymi zakończeniami linii na każdym końcu (strzałki, okręgi itp.
LineCapLineCap jest stylem zakończenia linii /J zgodnie z ISO 32000-1 §8.4.3.3 Tabela 54.
LineEndingStyleLineEndingStyle jest jedną z 10 kształtów zakończenia linii zgodnie z ISO 32000-1 §12.5.6.7 Tabela 176, używaną w wpisie /LE adnotacji /Line.
LineJoinLineJoin jest stylem łączenia linii /j zgodnie z ISO 32000-1 §8.4.3.4 Tabela 55.
LineStyleLineStyle opisuje, jak rysowana jest ścieżka z obrysem.
LinearGradientLinearGradient interpoluje kolor wzdłuż linii od (X1, Y1) do (X2, Y2).
LinkAnnotationLinkAnnotation jest klikalnym obszarem.
LinkHighlightModeLinkHighlightMode kontroluje wizualną informację zwrotną, gdy link zostaje aktywowany przez użytkownika (wartość /H zgodnie z ISO 32000-1 §12.5.6.5).
ListBoxFieldListBoxField jest polem wyboru listy jednokrotnego lub wielokrotnego wyboru.
MarginInfoMarginInfo opisuje marginesy lub wypełnienie w punktach: Góra / Prawo / Dół / Lewo.
MarkdownOptionsMarkdownOptions konfiguruje renderowanie Markdown.
MarkdownSaveOptionsMarkdownSaveOptions konfiguruje SaveMarkdown / WriteMarkdown.
MarkupParagraphMarkupParagraph to ciąg kolejnych linii tworzących jeden akapit.
MarkupSectionMarkupSection to kolumna akapitów (od lewej do prawej na stronie).
MessageWiadomość jest pojedynczą wiadomością czatu.
MessageImageMessageImage jest osadzonym obrazem dołączonym do wiadomości, wysłanym jako data: URL w formacie base64.
NUpOptionsNUpOptions konfiguruje impozycję NUp.
NUpOrderNUpOrder kontroluje kolejność, w jakiej strony źródłowe wypełniają komórki siatki arkusza N-up.
NamedActionNamedAction wyzwala wbudowaną komendę przeglądarki (FirstPage, Print, …).
NamedActionTypeNamedActionType identyfikuje jedną ze standardowych komend przeglądarki obsługiwanych przez /Named actions zgodnie z ISO 32000-1 §12.6.4.11.
NamedDestinationNamedDestination otacza odniesienie do nazwy w kolekcji NamedDestinations dokumentu.
NamedDestinationsNamedDestinations jest mapą nazwa-do-miejsca docelowego zgodnie z ISO 32000-1 §12.3.2.3.
NumberFieldNumberField jest polem tekstowym z akcją formatu liczbowego JavaScript, więc przeglądarki wyświetlają i walidują wartość jako sformatowaną liczbę.
NumberFormatOptionsNumberFormatOptions konfiguruje formatowanie wyświetlania NumberField (odpowiada AFNumber_Format w Acrobat).
OCRBoxOCRBox jest prostokątem w przestrzeni pikseli obrazu: początek w lewym górnym rogu, Y rośnie w dół (zwykła konwencja rastrowa — celowo odróżniona od przestrzeni użytkownika PDF).
OCREngineOCREngine rozpoznaje tekst na obrazie jednej strony.
OCRLineOCRLine jest jedną fizyczną linią tekstu.
OCRResultOCRResult jest rozpoznaną treścią obrazu jednej strony.
OCRWordOCRWord to szczegół na poziomie słowa w ramach linii, dla silników, które go udostępniają.
OcrCopilotOcrCopilot rozpoznaje tekst na zeskanowanych stronach.
OcrOptionsOcrOptions konfiguruje OcrCopilot.
OpenAIClientOpenAIClient komunikuje się z OpenAI-compatible chat-completions endpoint, używając wyłącznie standardowej biblioteki.
OpenAIClientOptionsOpenAIClientOptions konfiguruje NewOpenAIClient.
OptimizationOptionsOptimizationOptions wybiera, które redukcje Document.Optimize stosuje.
OptimizationResultOptimizationResult raportuje, co Document.Optimize zmieniło.
OptimizeImageOptionsOptimizeImageOptions kontroluje zachowanie optymalizacji obrazów.
OutlineItemCollectionOutlineItemCollection reprezentuje wpis w spisie oraz zbiór jego elementów podrzędnych.
PDFAFormatPDFAFormat identyfikuje poziom zgodności PDF/A.
PDFAIssuePDFAIssue opisuje pojedyncze naruszenie zgodności PDF/A.
PDFAValidationReportPDFAValidationReport jest zwracany przez (*Document).ValidatePDFA.
PDFUAIssuePDFUAIssue opisuje pojedyncze naruszenie zgodności PDF/UA (dostępności).
PDFUAValidationReportPDFUAValidationReport jest zwracany przez (*Document).ValidatePDFUA.
PagePage jest widokiem na żywo pojedynczej strony w dokumencie.
PageFormatPageFormat opisuje rozmiar strony w punktach (1/72 cala).
PageLabelRangePageLabelRange opisuje spójny ciąg stron, które mają wspólny styl numeracji.
PageLabelStylePageLabelStyle jest stylem numeracji stosowanym w PageLabelRange.
PageMarkupPageMarkup jest strukturalnym tekstem jednej strony.
PageNumberStampPageNumberStamp stempluje numer strony (i opcjonalnie całkowitą liczbę), sformatowany przez Format.
PageRangePageRange określa włączny zakres stron (liczonych od 1).
PageSizePageSize przechowuje szerokość i wysokość strony PDF w punktach (1/72 cala).
PasswordBoxFieldPasswordBoxField jest polem tekstowym, którego wprowadzane dane są maskowane (flaga Password).
PathŚcieżka jest sekwencją operacji MoveTo/LineTo/CurveTo/Close definiujących dowolną ścieżkę 2D w przestrzeni użytkownika PDF (punkt początkowy w lewym dolnym rogu strony, Y w górę).
PdfPageStampPdfPageStamp nakłada (lub podkłada) stronę z innego dokumentu PDF jako pieczątkę — strona źródłowa jest importowana raz jako Form XObject i rysowana w prostokącie pieczątki (Rect), skalowana tak, aby pasowała przy zachowaniu proporcji, pozycjonowana przy użyciu HAlign/VAlign oraz uwzględniająca Opacity, RotateAngle i Background.
PermissionsUprawnienia określają, co przeglądarka zezwala wykonać w zaszyfrowanym pliku PDF.
PngDevicePngDevice renderuje stronę do formatu PNG o stałej rozdzielczości.
PointPoint jest pojedynczym punktem w współrzędnych przestrzeni użytkownika PDF.
PolygonAnnotationPolygonAnnotation rysuje zamknięty wielokąt przez listę wierzchołków, z obrysowaną krawędzią i opcjonalnym wypełnieniem wnętrza.
PolylineAnnotationPolylineAnnotation rysuje otwartą polilinię przez listę wierzchołków, z obrysowaną krawędzią, opcjonalnymi zakończeniami linii przy pierwszym i ostatnim wierzchołku oraz opcjonalnym wypełnieniem wnętrza dla zamkniętych zakończeń.
QuadPointQuadPoint jest jednym czworokątem w tablicy /QuadPoints adnotacji markup.
RadialGradientRadialGradient interpoluje kolor od punktu ogniskowego (FX, FY) aż do koła ośrodkowanego w (CX, CY) o promieniu R.
RadioButtonFieldRadioButtonField jest grupą wzajemnie wykluczających się opcji.
RadioButtonOptionFieldRadioButtonOptionField jest jednym z widżetów opcji wewnątrz RadioButtonField.
RadioItemRadioItem opisuje jeden widżet w grupie radiowej.
RectangleRectangle reprezentuje prostokąt PDF [llx, lly, urx, ury] w punktach (1/72 cala).
RedactAnnotationRedactAnnotation oznacza obszary do redakcji.
RenderOptionsRenderOptions kontroluje rasteryzację strony.
ReplaceOptionsReplaceOptions dostraja sposób, w jaki ReplaceText dopasowuje tekst wyszukiwania.
ResetFormActionResetFormAction przywraca nazwane pola formularza do ich domyślnych wartości /DV.
ResolutionResolution jest rozdzielczością renderowania w DPI.
RichTextBoxFieldRichTextBoxField jest polem tekstowym, które zawiera wartość tekstu sformatowanego (RichText flag + /RV) oprócz zwykłego /V.
RotationAngleRotationAngle reprezentuje prawidłowy obrót strony PDF w stopniach zgodnie z ruchem wskazówek zegara.
RowRow jest pojedynczym wierszem w Table.
SVGSVG jest wstępnie przetworzonym dokumentem SVG.
SVGFontResolverSVGFontResolver mapuje rodzinę czcionek SVG + styl na pdf.Font.
SVGSaveOptionsSVGSaveOptions konfiguruje SaveSVG / WriteSVG.
SearchOptionsSearchOptions dostraja, jak SearchText interpretuje zapytanie.
ShapeStyleShapeStyle łączy obrys (LineStyle) z opcjonalnym kolorem wypełnienia.
SignOptionsSignOptions konfiguruje podpis cyfrowy.
SignatureAppearanceSignatureAppearance kontroluje zawartość i styl widocznego bloku podpisu.
SignatureVerificationSignatureVerification jest wynikiem weryfikacji jednego podpisu cyfrowego.
SquareAnnotationSquareAnnotation rysuje prostokątną adnotację z obramowaniem i opcjonalnym wypełnieniem wewnątrz.
SquigglyAnnotationSquigglyAnnotation rysuje falistą podkreślenie pod tekstem (zwykle używane jako wskazówki stylu sprawdzania pisowni).
StampPieczęć to treść nakładana na (lub pod) stronę: TextStamp, ImageStamp lub PageNumberStamp.
StampAnnotationStampAnnotation jest adnotacją w postaci pieczątki gumowej.
StampNameStampName nazwy zgodnie z ISO 32000-1 §12.5.6.13 Tabela 184.
StrikeOutAnnotationStrikeOutAnnotation rysuje poziomą linię przez tekst.
StructElementStructElement jest węzłem w drzewie struktury logicznej.
StructTypeStructType jest standardowym typem struktury PDF (ISO 32000-1 §14.8.4), używany jako wartość /S elementu struktury.
SubmitFormActionSubmitFormAction przesyła wartości pól formularza do adresu URL.
SubmitFormFlagsSubmitFormFlags jest polem bitowym /Flags dla akcji /SubmitForm zgodnie z ISO 32000-1 Tabela 237.
SummaryCopilotSummaryCopilot generuje streszczenia dokumentów przy użyciu modelu AI.
SummaryOptionsSummaryOptions konfiguruje SummaryCopilot.
TOCEntryTOCEntry to jedna linia spisu treści: tytuł, poziom wcięcia (0 = poziom najwyższy) oraz strona, na którą wskazuje.
TOCOptionsTOCOptions kontroluje sposób renderowania spisu treści.
TableTable jest tymczasowym konstruktorem układu tabelarycznego rysowanego na Page.
TaggedContentTaggedContent jest fasadą do tworzenia Tagged PDF (ISO 32000-1 §14.8): posiada logiczne drzewo struktury dokumentu i ustawia znaczniki katalogu wymagane przez PDF/UA.
TextAnnotationTextAnnotation jest adnotacją typu sticky-note.
TextBoxFieldTextBoxField jest jednoliniowym lub wieloliniowym polem tekstowym.
TextExtractOptionsTextExtractOptions konfiguruje ExtractText.
TextExtractionModeTextExtractionMode wybiera, w jaki sposób ExtractText porządkuje wyodrębniony tekst.
TextFragmentTextFragment reprezentuje ciągły fragment tekstu o jednolitym kroju czcionki.
TextIconTextIcon nazwy zgodnie z ISO 32000-1 §12.5.6.4 Tabela 172, używane w polu /Name adnotacji /Subtype /Text.
TextLineTextLine reprezentuje poziomą linię fragmentów tekstu na wspólnej pozycji Y.
TextMatchTextMatch jest pojedynczym wystąpieniem zlokalizowanym przez SearchText.
TextRecognitionResultTextRecognitionResult jest rozpoznanym tekstem jednej przetworzonej strony.
TextStampTextStamp nakłada się na linię (lub zawinięty blok) tekstu.
TextStyleTextStyle określa wielokrotnie używalne właściwości formatowania tekstu.
TiffDeviceTiffDevice renderuje strony do formatu TIFF.
TilingPatternTilingPattern jest wypełnieniem powtarzalnym (PatternType 1, ISO 32000-1 §8.7.3.1): mała komórka zawartości rozmieszczona w siatce na dowolnym kształcie, który wypełnia.
UnderlineAnnotationUnderlineAnnotation rysuje poziomą linię pod tekstem.
UsageRaporty użycia podają liczbę tokenów, gdy dostawca je zwraca.
VAlignVAlign określa pionowe wyrównanie tekstu w obrębie prostokąta.
ValidationIssueValidationIssue opisuje pojedynczy problem znaleziony w pliku PDF.
ValidationReportValidationReport jest zwracany przez Validate i podsumowuje integralność strukturalną pliku PDF.
WidgetAnnotationWidgetAnnotation jest widokiem tylko do odczytu adnotacji widgetu formularza udostępnionym poprzez AnnotationCollection.
XFormXForm jest wielokrotnego użytku Form XObject (ISO 32000-1 §8.10) — samodzielnym strumieniem treści (z własnymi zasobami), który może być umieszczony na dowolnej liczbie stron i w dowolnych pozycjach przy użyciu pojedynczego wywołania Do.
XMPMetadataXMPMetadata jest pakietem XMP dokumentu modelowanym jako wspólne pola schematu oraz lista dowolnych własnych właściwości Custom.
XMPPropertyXMPProperty jest pojedynczą prostą (wartość typu string) właściwością XMP w dowolnej przestrzeni nazw.

Zobacz także

 Polski