Document
סקירה כללית
Document היא מחלקה ב-Aspose.Words FOSS עבור .NET. יורשת מ-: DocumentBase, ISectionAttrSource, IWatermarkProvider.
הקונסטרוקטורים של מחלקת Document מאפשרים למפתחים ליצור מסמך ריק חדש או לטעון מסמך קיים מנתיב קובץ, זרם, או עם אפשרויות טעינה מותאמות.
מחלקה זו מספקת 63 שיטות לעבודה עם אובייקטי Document בתוכניות .NET. השיטות הזמינות כוללות: Accept, AcceptAllRevisions, AcceptEnd, AcceptStart, AppendChild, AppendDocument, Cleanup, Clone, CopyStylesFromTemplate, CreateNavigator, Document, EnsureMinimum, ועוד 36 שיטות נוספות. כל החברים הציבוריים נגשים לכל יישום .NET לאחר התקנת חבילת Aspose.Words FOSS עבור .NET. מאפיינים: AttachedTemplate, AutomaticallyUpdateStyles, BackgroundShape, Bibliography, BuiltInDocumentProperties, CompatibilityOptions, ועוד 62 נוספים.
מאפיינים
| שם | סוג | גישה | תיאור |
|---|---|---|---|
AttachedTemplate | string | קריאה/כתיבה | מקבל או מגדיר את הנתיב המלא של התבנית המחוברת למסמך. |
AutomaticallyUpdateStyles | bool | קריאה/כתיבה | מקבל או מגדיר דגל שמציין האם הסגנונות במסמך מתעדכנים כדי להתאים לסגנונות בתבנית המצורפת בכל פעם שהמסמך נפתח ב-MS Word. |
ShadeFormData | bool | קריאה/כתיבה | מציין האם להפעיל את הצללה האפורה על שדות הטופס. |
TrackRevisions | bool | קריאה/כתיבה | אמת אם השינויים מתועדים כאשר מסמך זה נערך ב-Microsoft Word. |
ShowGrammaticalErrors | bool | קריאה/כתיבה | מציין האם להציג שגיאות דקדוק במסמך זה. |
ShowSpellingErrors | bool | קריאה/כתיבה | מציין האם להציג שגיאות כתיב במסמך זה. |
SpellingChecked | bool | קריאה/כתיבה | מחזיר אמת אם המסמך נבדק לאיתור שגיאות כתיב. |
GrammarChecked | bool | קריאה/כתיבה | מחזיר אמת אם המסמך נבדק לדקדוק. |
PunctuationKerning | bool | קריאה/כתיבה | מציין האם קירנינג חל גם על טקסט לטיני וגם על סימני פיסוק. |
NodeType | NodeType | קריאה | מחזיר Document. |
BuiltInDocumentProperties | BuiltInDocumentProperties | קריאה | מחזירה אוסף שמייצג את כל המאפיינים המובנים של המסמך. |
WebExtensionTaskPanes | TaskPaneCollection | קריאה | מחזירה אוסף שמייצג רשימה של תוספי לוח משימות. |
CustomDocumentProperties | CustomDocumentProperties | קריאה | מחזירה אוסף שמייצג את כל המאפיינים המותאמים אישית של המסמך. |
ProtectionType | ProtectionType | קריאה | מקבל את סוג ההגנה הפעיל של המסמך. |
Sections | SectionCollection | קריאה | מחזיר אוסף שמייצג את כל החלקים במסמך. |
FirstSection | Section | קריאה | מקבל את הקטע הראשון במסמך. |
LastSection | Section | קריאה | מקבל את הקטע האחרון במסמך. |
ViewOptions | ViewOptions | קריאה | מספק אפשרויות לשליטה באופן שבו המסמך מוצג ב-Microsoft Word. |
WriteProtection | WriteProtection | קריאה | מספק גישה לאפשרויות הגנת כתיבה של המסמך. |
CompatibilityOptions | CompatibilityOptions | קריאה | מספק גישה לאפשרויות התאימות של המסמך (כלומר, ההעדפות שהמשתמש הזין בלשונית Compatibility בתיבת הדו-שיח Options ב-Word). |
MailMergeSettings | MailMergeSettings | קריאה/כתיבה | מקבל או מגדיר את האובייקט שמכיל את כל מידע המיזוג הדואר של מסמך. |
HyphenationOptions | HyphenationOptions | קריאה | מספק גישה לאפשרויות ההיפנציה של המסמך. |
HasRevisions | bool | קריאה | מחזיר true אם למסמך יש שינויים במעקב. |
HasMacros | bool | קריאה | מחזיר true אם למסמך יש פרויקט VBA (מאקרו). |
Watermark | Watermark | קריאה | מספק גישה לסימן המים של המסמך. |
VersionsCount | int | קריאה | מקבל את מספר גרסאות המסמך שנשמרו במסמך DOC. |
DefaultTabStop | double | קריאה/כתיבה | מקבל או מגדיר את המרווח (בנקודות) בין עצירות הטאבים המוגדרות כברירת מחדל. |
Theme | Theme | קריאה | מקבל את אובייקט Theme עבור מסמך זה. |
CustomXmlParts | CustomXmlPartCollection | קריאה/כתיבה | מקבל או מגדיר את האוסף של חלקי אחסון נתונים מותאמים אישית XML. |
PackageCustomParts | CustomPartCollection | קריאה/כתיבה | מקבל או מגדיר את האוסף של חלקים מותאמים (תוכן שרירותי) המקושרים לחבילת OOXML באמצעות “unknown relationships”. |
Variables | VariableCollection | קריאה | מחזיר את האוסף של המשתנים שנוספו למסמך או לתבנית. |
GlossaryDocument | GlossaryDocument | קריאה/כתיבה | מקבל או מגדיר את מסמך המונון בתוך מסמך זה או בתבנית. |
OriginalFileName | string | קריאה | מקבל את שם הקובץ המקורי של המסמך. |
OriginalLoadFormat | LoadFormat | קריאה | מקבל את פורמט המסמך המקורי שהוטען לאובייקט זה. |
Compliance | OoxmlCompliance | קריאה | מקבל את גרסת ההתאימות ל-OOXML שנקבעה מתוך תוכן המסמך שהוטען. |
DigitalSignatures | DigitalSignatureCollection | קריאה | מקבל את האוסף של החתימות הדיגיטליות למסמך זה ואת תוצאות האימות שלהן. |
FontSettings | FontSettings | קריאה/כתיבה | מקבל או מגדיר את הגדרות הגופן של המסמך. |
Bibliography | Bibliography.Bibliography | קריאה | מקבל את אובייקט Bibliography שמייצג את רשימת המקורות הזמינים במסמך. |
Frameset | Frameset | קריאה | מחזיר מופע של Frameset אם המסמך הזה מייצג דף מסגרות. |
IncludeTextboxesFootnotesEndnotesInStat | bool | קריאה/כתיבה | קובע האם לכלול תיבות טקסט, הערות שוליים והערות סופיות בסטטיסטיקות של ספירת מילים. |
Revisions | RevisionCollection | קריאה | מקבל אוסף של גרסאות (שינויים במעקב) הקיימות במסמך זה. |
RevisionsView | RevisionsView | קריאה/כתיבה | מקבל או מגדיר ערך המציין האם לעבוד עם הגרסה המקורית או עם הגרסה המתוקנת של מסמך. |
JustificationMode | JustificationMode | קריאה/כתיבה | מקבל או מגדיר את התאמת ריווח התווים של מסמך. |
FootnoteOptions | FootnoteOptions | קריאה | מספק אפשרויות השולטות במספור ובמיקום של הערות שוליים במסמך זה. |
EndnoteOptions | EndnoteOptions | קריאה | מספק אפשרויות השולטות במספור ובמיקום של הערות סיום במסמך זה. |
FieldOptions | FieldOptions | קריאה | מקבל אובייקט FieldOptions שמייצג אפשרויות לשליטה בטיפול בשדות במסמך. |
RemovePersonalInformation | bool | קריאה/כתיבה | מקבל או מגדיר דגל שמצביע על כך ש-Microsoft Word יסיר את כל המידע על המשתמש מההערות, הגרסאות ותכונות המסמך בעת שמירת המסמך. |
VbaProject | VbaProject | קריאה/כתיבה | מקבל או מגדיר VbaProject. |
Document | DocumentBase | קריאה | מקבל את המופע הזה. |
NodeChangingCallback | INodeChangingCallback | קריאה/כתיבה | נקרא כאשר צומת מתווסף או מוסר במסמך. |
ResourceLoadingCallback | IResourceLoadingCallback | קריאה/כתיבה | מאפשר לשלוט באופן שבו משאבים חיצוניים נטענים. |
FontInfos | FontInfoCollection | קריאה | מספק גישה למאפייני הגופנים המשמשים במסמך זה. |
Styles | StyleCollection | קריאה | מחזיר אוסף של סגנונות המוגדרים במסמך. |
Lists | ListCollection | קריאה | מספק גישה לעיצוב הרשימות המשמש במסמך. |
WarningCallback | IWarningCallback | קריאה/כתיבה | נקרא במהלך פרוצדורות עיבוד שונות של המסמך כאשר מתגלה בעיה שעשויה לגרום לאובדן דיוק בנתונים או בעיצוב. |
FootnoteSeparators | FootnoteSeparatorCollection | קריאה | מספק גישה למפרידי ההערות השוליות/הערות הסיום המוגדרים במסמך. |
BackgroundShape | Shape | קריאה/כתיבה | מקבל או מגדיר את צורת הרקע של המסמך. |
PageColor | Color | קריאה/כתיבה | מקבל או מגדיר את צבע העמוד של המסמך. |
IsComposite | bool | קריאה | מחזיר true מכיוון שהצומת הזה יכול להכיל צמתים ילדים. |
HasChildNodes | bool | קריאה | מחזיר true אם ל-node הזה יש צמתים בנים. |
FirstChild | Node | קריאה | מקבל את הילד הראשון של הצומת. |
LastChild | Node | קריאה | מקבל את הילד האחרון של הצומת. |
Count | int | קריאה | מקבל את מספר הילדים הישירים של הצומת הזה. |
ParentNode | CompositeNode | קריאה | מקבל את ההורה הישיר של הצומת הזה. |
PreviousSibling | Node | קריאה | מקבל את הצומת שממוקמת מיד לפני הצומת הזה. |
NextSibling | Node | קריאה | מקבל את הצומת המיידי אחרי צומת זה. |
Range | Range | קריאה | מחזיר אובייקט Range המייצג את החלק של המסמך שנמצא בתוך צומת זה. |
CustomNodeId | int | קריאה/כתיבה | מציין מזהה צומת מותאם אישית. |
שיטות
| חתימה | תיאור |
|---|---|
Document() | יוצר או טוען מסמך. |
Document(fileName: string) | פותח מסמך קיים מקובץ. |
Document(fileName: string, loadOptions: LoadOptions) | פותח מסמך קיים מקובץ. |
Document(stream: Stream) | קורא ל-Document(stream) על מופע המסמך הזה. |
Document(stream: Stream, loadOptions: LoadOptions) | קורא ל-Document(stream, loadOptions) על מופע המסמך הזה. |
Clone() | מבצע העתקה עמוקה של המסמך. |
Accept(visitor: DocumentVisitor) | קורא VisitDocumentStart, ואז קורא Accept לכל צמתים הבנים של המסמך וקורא VisitDocumentEnd בסוף. |
AcceptStart(visitor: DocumentVisitor) | מקבל מבקר לביקור בתחילת המסמך. |
AcceptEnd(visitor: DocumentVisitor) | מקבל מבקר לביקור בסוף המסמך. |
AppendDocument(srcDoc: Document, importFormatMode: ImportFormatMode) | מוסיף את המסמך שצוין לסוף מסמך זה. |
AppendDocument(srcDoc: Document, importFormatMode: ImportFormatMode, importFormatOptions: ImportFormatOptions) | מצרף את המסמך המוגדר לסוף מסמך זה. |
Save(fileName: string) | שומר את המסמך. |
Save(fileName: string, saveFormat: SaveFormat) | שומר את המסמך לקובץ בפורמט המוגדר. |
Save(fileName: string, saveOptions: SaveOptions) | שומר את המסמך לקובץ באמצעות אפשרויות השמירה המוגדרות. |
Save(stream: Stream, saveFormat: SaveFormat) | עומסי יתר מאפשרים שמירת מסמך בשם קובץ או בזרם, עם אפשרות לציין פורמט שמירה או אפשרויות שמירה מפורטות |
Save(stream: Stream, saveOptions: SaveOptions) | קורא Save(stream, saveOptions) על מופע המסמך הזה. |
Save(response: HttpResponse, fileName: string, contentDisposition: ContentDisposition, saveOptions: SaveOptions) | שולח את המסמך לדפדפן הלקוח. |
EnsureMinimum() | אם המסמך אינו מכיל סעיפים, נוצר סעיף אחד עם פסקה אחת. |
AcceptAllRevisions() | מקבל את כל השינויים המתועדים במסמך. |
Protect(type: ProtectionType) | מגן על המסמך מפני שינויים. |
Protect(type: ProtectionType, password: string) | מגן על המסמך מפני שינויים ובאופן אופציונלי מגדיר סיסמת הגנה. |
Unprotect() | מסיר את ההגנה מהמסמך. |
Unprotect(password: string) | מסיר את ההגנה מהמסמך אם סיסמה נכונה מצוינת. |
UpdateTableLayout() | מיישם גישה מוקדמת יותר לחישוב מחדש של רוחבי עמודות בטבלה שיש לה בעיות ידועות. |
UpdateListLabels() | מעדכן את תוויות הרשימות לכל פריטי הרשימה במסמך. |
UpdateActualReferenceMarks() | מעדכן את המאפיין ActualReferenceMark של כל ההערות התחתונות וההערות הסופיות במסמך. |
RemoveMacros() | מסיר את כל המקרו (פרויקט VBA) וכן סרגלי כלים והתאמות פקודות מהמסמך. |
UpdateFields() | מעדכן את ערכי השדות בכל המסמך. |
UnlinkFields() | מנתק שדות בכל המסמך. |
NormalizeFieldTypes() | משנה את ערכי סוג השדה FieldType של FieldStart, FieldSeparator, FieldEnd בכל המסמך כך שהם תואמים לסוגי השדה הכלולים בקודי השדה. |
JoinRunsWithSameFormatting() | מחבר ריצות עם אותו העיצוב בכל הפסקאות של המסמך. |
ExpandTableStylesToDirectFormatting() | ממיר עיצוב המוגדר בסגנונות טבלאות לעיצוב ישיר בטבלאות במסמך. |
Cleanup() | מנקה סגנונות ורשימות שלא בשימוש מהמסמך. |
Cleanup(options: CleanupOptions) | מנקה סגנונות ורשימות שלא בשימוש מהמסמך בהתאם ל-CleanupOptions שניתן. |
RemoveExternalSchemaReferences() | מסיר הפניות חיצוניות של סכמת XML מהמסמך הזה. |
StartTrackRevisions(author: string, dateTime: DateTime) | מתחיל לסמן אוטומטית את כל השינויים העתידיים שתבצע במסמך באופן תכנותי כתיקוני גרסה. |
StartTrackRevisions(author: string) | מתחיל לסמן אוטומטית את כל השינויים העתידיים שתבצע במסמך באופן תכנותי כתיקוני גרסה. |
StopTrackRevisions() | מפסיק את הסימון האוטומטי של שינויים במסמך כתיקונים. |
CopyStylesFromTemplate(template: string) | מעתיק סגנונות מהתבנית המצוינת למסמך. |
CopyStylesFromTemplate(template: Document) | מעתיק סגנונות מהתבנית המצוינת למסמך. |
ImportNode(srcNode: Node, isImportChildren: bool) | מייבא צומת ממסמך אחר למסמך הנוכחי. |
GetText() | מקבל את הטקסט של צומת זה ושל כל הצמתים שלו. |
GetChildNodes(nodeType: NodeType, isDeep: bool) | מחזיר אוסף של צמתים צאצאים התואמים לסוג המצויין. |
GetChild(nodeType: NodeType, index: int, isDeep: bool) | מחזיר את הצומת הצאצאי ה-Nth המתאים לסוג המצויין. |
SelectNodes(xpath: string) | בוחר רשימה של צמתים המתאימים לביטוי ה-XPath. |
SelectSingleNode(xpath: string) | בוחר את ה-Node הראשון המתאים לביטוי ה-XPath. |
GetEnumerator() | מספק תמיכה באיטרציה בסגנון for each על הצמתים הבנים של צומת זה. |
AppendChild(newChild: T) | מוסיף את הצומת שצוין לסוף רשימת הצמתים הבנים של צומת זה. |
PrependChild(newChild: T) | מוסיף את הצומת שצוין להתחלה של רשימת הצמתים הבנים של צומת זה. |
InsertAfter(newChild: T, refChild: Node) | מכניס את הצומת שצוין מיד אחרי צומת ההתייחסות שצוין. |
InsertBefore(newChild: T, refChild: Node) | מכניס את הצומת שצוין מיד לפני צומת ההתייחסות שצוין. |
RemoveChild(oldChild: T) | מסיר את צומת הילד שצוין. |
RemoveAllChildren() | מסיר את כל הצמתים הבנים של הצומת הנוכחי. |
RemoveSmartTags() | מסיר את כל צמתי הצאצא של SmartTag מהצומת הנוכחי. |
IndexOf(child: Node) | מחזיר את האינדקס של צומת הילד המוגדר במערך צמתים בנים. |
CreateNavigator() | יוצר לנווט שניתן להשתמש בו כדי לעבור ולקרוא צמתים. |
GetAncestor(ancestorType: Type) | מקבל את הקודמת הראשונה של סוג האובייקט שצוין. |
GetAncestorOf() | קורא ל-GetAncestorOf על מופע ה-Document הזה. |
Remove() | מסיר את עצמו מההורה. |
NextPreOrder(rootNode: Node) | מקבל את הצומת הבא על פי אלגוריתם ההליכה בעץ לפי סדר-קדם. |
PreviousPreOrder(rootNode: Node) | מקבל את הצומת הקודם על פי אלגוריתם ההליכה בעץ לפי סדר-קדם. |
ToString(saveFormat: SaveFormat) | מייצא את תוכן הצומת למחרוזת בפורמט שצוין. |
NodeTypeToString(nodeType: NodeType) | מתודה עזר שממירה ערך enum של סוג הצומת למחרוזת ידידותית למשתמש. |