מסמך – Aspose FOSS API Reference

מסמך

סקירה כללית

Document הוא שיעור ב Aspose.PDF FOSS עבור Java. מורשת מ : Closeable.

שיעור מרכזי לעבודה עם מסמכים PDF (ISO 32000-1:2008).

שיעור זה מספק 96 שיטות לעבוד עם אובייקטים של מסמכים בתוכניות Java. שיטות זמינות כוללות: Document, allocateObjectNumber, close, convert, convertToPdfA2B, decrypt, encrypt, exportAnnotationsToXfdf, flatten, getActions, getBackground, getCatalog,59 שיטות נוספות. כל החברים הציבוריים זמינים לכל יישום Java לאחר התקנת Aspose.PDF FOSS עבור חבילת Java. רכוש : actions, background, catalog, centerWindow, collection, displayDocTitle,32 ועוד.

נכסים

שם	סוג	גישה	תיאור
`background`	`Color`	קראו	החזיר את צבע הרקע ברמת המסמך שנקבע באמצעות
{@link #setBackground(Color)} או {_code null} עבור אף אחד.
`pages`	`PageCollection`	קראו	מקבל את הדפים.
`info`	`DocumentInfo`	קראו	החזיר את מילון המידע של המסמך (ISO 32000-1:2008, §14.3.3).
`orCreateInfo`	`DocumentInfo`	קראו	מוטב על ידי {@link #getInfo()}.
`metadata`	`XmpMetadata`	קראו	החזיר את הנתונים המוטאטיים של XMP של המסמך הזה.
`version`	`String`	קראו	החזיר את שורת הגרסה PDF (לדוגמה,.
`catalog`	`PdfDictionary`	קראו	החזיר את המילון של הקלטת השורש.
`actions`	`DocumentActions`	קראו	החזיר את הגורמים לפעולה ברמת המסמך (ISO 32000-1:2008, §12.6.4.1):
{@code /OpenAction} בתוספת ההרשמה {_code/AA} (סגור, ימשיך/תשמור,
• דפוס / הדפסה.
`trailer`	`PdfDictionary`	קראו	חזרתי לקטגוריה של טריילר.
`parser`	`PDFParser`	קראו	החזיר את הדפדפן PDF הבסיסי (לשימוש פנימי על ידי מרכיבי מנוע).
`outlines`	`OutlineCollection`	קראו	החזיר את מסמך המקור (Bookmarks) אוסף.
`form`	`Form`	קראו	החזיר את הטופס האינטראקטיבי (AcroForm) של מסמך זה.
`embeddedFiles`	`EmbeddedFileCollection`	קראו	החזיר את אוסף הקבצים המובנים (התוויות).
`collection`	`Collection`	קראו	החזיר את הפורטל של המסמך {@link Collection}, על ידי התקנת
1 ריק בראשון לציון.
`fontUtilities`	`FontUtilities`	קראו	החזיר את האפליקציות של הפרוטוקול עבור מסמך זה.
`embedStandardFonts`	`boolean`	קראו	החזיר אם 14 טופס PDF סטנדרטי צריך להיות מוטבע בעת חיסכון.
`layers`	`java.util.List<Layer>`	קראו	החזיר את רשימת קבוצות התוכן האופציונליות (הצניחים).
`viewerPreferences`	`ViewerPreferences`	קראו	החזיר את העדפות הקהל.
`hideToolbar`	`boolean`	קראו	להסתיר את העדפה של toolbar.
`hideMenubar`	`boolean`	קראו	להסתיר את העדפה של המנואר.
`hideWindowUI`	`boolean`	קראו	הסתיר את חלון UI העדפה.
`fitWindow`	`boolean`	קראו	חלון עדיפות.
`centerWindow`	`boolean`	קראו	חלון מרכז העדפה.
`displayDocTitle`	`boolean`	קראו	הצג את העדפה של כותרת המסמך.
`pageLayout`	`String`	קראו	הפריסה של הדף (SinglePage, OneColumn , TwoColumnLeft וכו ‘).
`pageMode`	`PageMode`	קראו	מקבל את מצב הדף.
`pageInfo`	`PageInfo`	קראו	שמור את המסמך לקובץ.
`linearized`	`boolean`	קראו	החזיר אם המסמך הנוכחי הוא ליניארי עבור תצוגה מהירה באינטרנט.
`sourcePath`	`String`	קראו	החזרה למסלול הקובץ מסמך זה הועלה, או {@code null} עבור מסמנים חדשים
או מסמכים שנלכדו מהזרם.
`fileName`	`String`	קראו	החזיר את שם הקובץ (דרך) מסמך זה נפתח.
`namedDestinations`	`NamedDestinations`	קראו	החזיר את אוסף היעד הנקרא של המסמך.
`pageLabels`	`PageLabels`	קראו	החזיר את התוויות של הדף, או {@code null} אם {_code /PageLabels} אינו נוכח.
`taggedContent`	`TaggedContent`	קראו	החזיר את התוכן המותג של המסמך, ומספק גישה לעץ המבנה הלוגי.
`logicalStructure`	`StructTreeRoot`	קראו	החזיר את עץ המבנה הלוגי לקריאה.
`encrypted`	`boolean`	קראו	החזיר את האמת אם המסמך הזה מוצפן.
`javaScript`	`JavaScriptCollection`	קראו	החזיר את הקולקציה JavaScript מהעץ השם של המסמך.
`pdfaCompliant`	`boolean`	קראו	החזיר את האמת אם המסמך הזה תואם PDF/A (הגדר לאחר הטרנספורמציה() או אימות().
`pdfFormat`	`PdfFormat`	קראו	החזיר את פורמט PDF של מסמך זה לאחר ההפוך.

שיטות

חתימה	תיאור
`Document(filePath: String)`	פותח מסמך PDF מתוך מסלול קובץ.
`Document(filePath: String, password: String)`	פותח מסמך PDF מתוך מסלול קובץ עם סיסמה.
`Document(filePath: String, password: String, customHandler: ICustomSecurityHandler)`	פותח מסמך PDF ממסלול קובץ באמצעות מנהל אבטחה מותאם אישית.
`Document(stream: InputStream)`	פותח מסמך PDF מתוך זרם כניסה.
`Document(stream: InputStream, password: String)`	פותח מסמך PDF מתוך זרם כניסה עם סיסמה.
`Document(stream: InputStream, password: String, customHandler: ICustomSecurityHandler)`	פותח מסמך PDF מתוך זרם כניסה באמצעות מעבד אבטחה מותאם אישית.
`Document()`	יצירת מסמך PDF ריק חדש.
`Document(filePath: String, options: HtmlLoadOptions)`	יצירת מסמך PDF מתוך קובץ HTML.
`Document(stream: InputStream, options: HtmlLoadOptions)`	יצירת מסמך PDF מתוך זרם כניסה HTML.
`getBackground()` → `Color`	החזיר את צבע הרקע ברמת המסמך שנקבע באמצעות
{@link #setBackground(Color)} או {_code null} עבור אף אחד.
`setBackground(color: Color)`	חובה להגדיר צבע רקע מוצק לכל דף במסמך.
(באמצעות העמוד #SetBackground(Color) ).
`getPages()` → `PageCollection`	להחזיר את הדפים.
`getInfo()` → `DocumentInfo`	החזיר את מילון המידע של המסמך (ISO 32000-1:2008, §14.3.3).
`getOrCreateInfo()` → `DocumentInfo`	מוטב על ידי {@link #getInfo()}.
`getMetadata()` → `XmpMetadata`	החזיר את הנתונים המוטאטיים של XMP של המסמך הזה.
`setXmpMetadata(stream: InputStream)`	הגדר את הנתונים המוטאטיים של XMP מתוך ביטים XML ירוקים לקרוא מהזרם.
`getXmpMetadata(stream: OutputStream)`	כותב את ה-XMP metadata XML bytes לתוך זרימת היציאה.
`getVersion()` → `String`	החזיר את שורת הגרסה PDF (לדוגמה,.
`getCatalog()` → `PdfDictionary`	החזיר את המילון של הקלטת השורש.
`getActions()` → `DocumentActions`	החזיר את הגורמים לפעולה ברמת המסמך (ISO 32000-1:2008, §12.6.4.1):
{@code /OpenAction} בתוספת ההרשמה {_code/AA} (סגור, ימשיך/תשמור,
• דפוס / הדפסה.
`getTrailer()` → `PdfDictionary`	חזרתי לקטגוריה של טריילר.
`getParser()` → `PDFParser`	החזיר את הדפדפן PDF הבסיסי (לשימוש פנימי על ידי מרכיבי מנוע).
`getOutlines()` → `OutlineCollection`	החזיר את מסמך המקור (Bookmarks) אוסף.
`getForm()` → `Form`	החזיר את הטופס האינטראקטיבי (AcroForm) של מסמך זה.
`getEmbeddedFiles()` → `EmbeddedFileCollection`	החזיר את אוסף הקבצים המובנים (התוויות).
`getCollection()` → `Collection`	החזיר את הפורטל של המסמך {@link Collection}, על ידי התקנת
1 ריק בראשון לציון.
`setCollection(value: Collection)`	להחליף (או להסיר, כאשר {@code value == null}) את המסמך
פורטל →.
`getFontUtilities()` → `FontUtilities`	החזיר את האפליקציות של הפרוטוקול עבור מסמך זה.
`isEmbedStandardFonts()` → `boolean`	החזיר אם 14 טופס PDF סטנדרטי צריך להיות מוטבע בעת חיסכון.
`setEmbedStandardFonts(embed: boolean)`	קבע אם 14 טופס PDF סטנדרטי צריך להיות מוטבע בעת חיסכון.
`getLayers()` → `java.util.List<Layer>`	החזיר את רשימת קבוצות התוכן האופציונליות (הצניחים).
`getViewerPreferences()` → `ViewerPreferences`	החזיר את העדפות הקהל.
`getHideToolbar()` → `boolean`	להסתיר את העדפה של toolbar.
`setHideToolbar(v: boolean)`	להגדיר את העדפה של סרגל כלי.
`getHideMenubar()` → `boolean`	להסתיר את העדפה של המנואר.
`setHideMenubar(v: boolean)`	להגדיר את העדפה של מונופול.
`getHideWindowUI()` → `boolean`	הסתיר את חלון UI העדפה.
`setHideWindowUI(v: boolean)`	הגדרת חלון UI מועדף.
`getFitWindow()` → `boolean`	חלון עדיפות.
`setFitWindow(v: boolean)`	הגדרת חלון מתאים עדיפות.
`getCenterWindow()` → `boolean`	חלון מרכז העדפה.
`setCenterWindow(v: boolean)`	הגדרת חלון מרכז העדפה.
`getDisplayDocTitle()` → `boolean`	הצג את העדפה של כותרת המסמך.
`setDisplayDocTitle(v: boolean)`	הגדרת העדפה של כותרת מסמך.
`getPageLayout()` → `String`	הפריסה של הדף (SinglePage, OneColumn , TwoColumnLeft וכו ‘).
`setPageLayout(layout: String)`	תכנון דף Layout.
`getPageMode()` → `PageMode`	החזיר את מצב הדף.
`setPageMode(mode: PageMode)`	הגדרת מצב הדף.
`getPageInfo()` → `PageInfo`	שמור את המסמך לקובץ.
`processParagraphs()`	מעבדים את הפסוקים עבור כל הדפים (העברת ההרצאה).
`save(filePath: String)`	@param filePath את מסלול הקובץ היציאה
@throws IOException אם כתיבה נכשלת
@throws IllegalArgumentException אם filePath הוא אפס
/
`save()`	שמור את המסמך בחזרה למסלול היעד הקשור אליו.
`save(outputStream: OutputStream)`	שמור את המסמך לתוך זרם היציאה.
`hasIncrementalUpdate()` → `boolean`	החזיר אם המסמך הנוכחי מכיל עדכונים אינטנסיביים.
`optimize()`	דורש תיקון מלא על ההצעה הבאה במקום תוספת אינטנסיבית.
`requestFullRewrite()`	דרישות שהפעולה הבאה של חיסכון מבצעת מחדש מלא, גם אם
אחרת ההצלה עלולה להיות אפשרית.
`isLinearized()` → `boolean`	החזיר אם המסמך הנוכחי הוא ליניארי עבור תצוגה מהירה באינטרנט.
`optimizeResources()`	הסר את המשאבים ברמת הדף הלא בשימוש לפני ההצלה הבאה.
`optimizeResources(options: org.aspose.pdf.optimization.OptimizationOptions)`	אופטימיזציה של המסמך בהתאם לאפשרויות המוצעות לפני ההמשך.
להציל את.
`save(filePath: String, format: SaveFormat)`	שמור את המסמך בפורמט שנקבע.
`save(filePath: String, options: PdfSaveOptions)`	שמור את המסמך עם אפשרויות אחסון PDF המפורטות.
`save(filePath: String, options: HtmlSaveOptions)`	שמור את המסמך כ- HTML עם האפשרויות המפורטות.
`getSourcePath()` → `String`	החזרה למסלול הקובץ מסמך זה הועלה, או {@code null} עבור מסמנים חדשים
או מסמכים שנלכדו מהזרם.
`getFileName()` → `String`	החזיר את שם הקובץ (דרך) מסמך זה נפתח.
`setFileName(fileName: String)`	הקלד את שם הקובץ המצורף לתיעוד זה.
`exportAnnotationsToXfdf(filePath: String)`	לחלץ את כל ההערות מהמסמך הזה לקובץ XFDF.
`exportAnnotationsToXfdf(stream: OutputStream)`	החליפו את כל ההערות מהמסמך הזה לתוך זרם תוצאות של XFDF.
`importAnnotationsFromXfdf(filePath: String)`	ייבוא הערות מתוך קובץ XFDF לתוך המסמך הזה.
`importAnnotationsFromXfdf(stream: InputStream)`	ייבוא הערות מתוך זרם כניסה XFDF לתוך המסמך הזה.
`flatten()`	לחתוך את כל המסמך: לחדף את כולם של הערות וצורה שדה מראה
לתוך שרידי תוכן הדף, ולאחר מכן להסיר את הערות ופורמטים שדות.
`flatten(settings: Form.FlattenSettings)`	לחתוך את המסמך באמצעות הגדרות לחתיכת הצורה המפורטות.
`getNamedDestinations()` → `NamedDestinations`	החזיר את אוסף היעד הנקרא של המסמך.
`getPageLabels()` → `PageLabels`	החזיר את התוויות של הדף, או {@code null} אם {_code /PageLabels} אינו נוכח.
`getTaggedContent()` → `TaggedContent`	החזיר את התוכן המותג של המסמך, ומספק גישה לעץ המבנה הלוגי.
`getLogicalStructure()` → `StructTreeRoot`	החזיר את עץ המבנה הלוגי לקריאה.
`allocateObjectNumber()` → `int`	הוספת מספר אובייקט חדש לאוביין עקיף חדש.
`registerImportedObject(body: PdfBase)` → `PdfObjectReference`	רשום פריט שהובא ממסמך אחר תחת מסמכים מעורבים בצורה טריה
מפתח.
`isEncrypted()` → `boolean`	החזיר את האמת אם המסמך הזה מוצפן.
`encrypt(userPassword: String, ownerPassword: String, permissions: int, cryptoAlgorithm: CryptoAlgorithm)`	הצפנה את המסמך באמצעות סיסמאות משתמש ובעלי באמצעות האלגוריתם המוגדר.
`encrypt(userPassword: String, ownerPassword: String, privilege: org.aspose.pdf.facades.DocumentPrivilege, customHandler: ICustomSecurityHandler)`	הצפנה את המסמך באמצעות סוחר אבטחה מותאם אישית.
`encrypt(userPassword: String, ownerPassword: String, privilege: org.aspose.pdf.facades.DocumentPrivilege, cryptoAlgorithm: CryptoAlgorithm, usePdf20: boolean)`	הצפנה של המסמך באמצעות סיסמאות משתמש ובעלי באמצעות האלגוריתם המוגדר
והפרשנות נקבעת.
`decrypt()`	מפרק את המסמך, הסיר הצפנה.
`getJavaScript()` → `JavaScriptCollection`	החזיר את הקולקציה JavaScript מהעץ השם של המסמך.
`validate(outputLogPath: String, format: PdfFormat)` → `boolean`	מאומת את המסמך נגד הפרופיל של פורמט PDF המוגדר.
`validate(logStream: OutputStream, format: PdfFormat)` → `boolean`	מאומת את המסמך נגד הפרופיל של פורמט PDF המוגדר.
`validate(options: PdfFormatConversionOptions)` → `boolean`	אימות המסמך באמצעות אובייקט של אפשרות אישור PDF/A.
`convert(outputLogPath: String, format: PdfFormat, action: ConvertErrorAction)` → `boolean`	הפוך את המסמך לתבנית PDF המוגדרת.
`convert(logStream: OutputStream, format: PdfFormat, action: ConvertErrorAction)` → `boolean`	הפוך את המסמך לתבנית PDF המוגדרת.
`convert(logStream: OutputStream, format: PdfFormat, action: ConvertErrorAction, transparencyAction: ConvertTransparencyAction)` → `boolean`	התייחסות לניהול ברור וברור.
`convert(options: PdfFormatConversionOptions)` → `boolean`	משתמשים באפשרויות המרה מפורטות.
`convertToPdfA2B(outputLogPath: String)` → `boolean`	הפוך את PDF הזה לתבנית PDF/A-2B.
`convertToPdfA2B(logStream: OutputStream)` → `boolean`	הפוך את PDF הזה לתבנית PDF/A-2B.
`repair()`	ניסיונות לתקן בעיות מבניות קטנות לפני שמירה, אימות או
זרימת עבודה של שינוי.
`isPdfaCompliant()` → `boolean`	החזיר את האמת אם המסמך הזה תואם PDF/A (הגדר לאחר הטרנספורמציה() או אימות().
`getPdfFormat()` → `PdfFormat`	החזיר את פורמט PDF של מסמך זה לאחר ההפוך.
`close()`	סגור את המסמך ומשחרר את המשאבים הבסיסיים.

ראה גם

Aspose.PDF for Java — Enterprise API Reference