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 נוספים.

מאפיינים

שםסוגגישהתיאור
AttachedTemplatestringקריאה/כתיבהמקבל או מגדיר את הנתיב המלא של התבנית המחוברת למסמך.
AutomaticallyUpdateStylesboolקריאה/כתיבהמקבל או מגדיר דגל שמציין האם הסגנונות במסמך מתעדכנים כדי להתאים לסגנונות בתבנית המצורפת בכל פעם שהמסמך נפתח ב-MS Word.
ShadeFormDataboolקריאה/כתיבהמציין האם להפעיל את הצללה האפורה על שדות הטופס.
TrackRevisionsboolקריאה/כתיבהאמת אם השינויים מתועדים כאשר מסמך זה נערך ב-Microsoft Word.
ShowGrammaticalErrorsboolקריאה/כתיבהמציין האם להציג שגיאות דקדוק במסמך זה.
ShowSpellingErrorsboolקריאה/כתיבהמציין האם להציג שגיאות כתיב במסמך זה.
SpellingCheckedboolקריאה/כתיבהמחזיר אמת אם המסמך נבדק לאיתור שגיאות כתיב.
GrammarCheckedboolקריאה/כתיבהמחזיר אמת אם המסמך נבדק לדקדוק.
PunctuationKerningboolקריאה/כתיבהמציין האם קירנינג חל גם על טקסט לטיני וגם על סימני פיסוק.
NodeTypeNodeTypeקריאהמחזיר Document.
BuiltInDocumentPropertiesBuiltInDocumentPropertiesקריאהמחזירה אוסף שמייצג את כל המאפיינים המובנים של המסמך.
WebExtensionTaskPanesTaskPaneCollectionקריאהמחזירה אוסף שמייצג רשימה של תוספי לוח משימות.
CustomDocumentPropertiesCustomDocumentPropertiesקריאהמחזירה אוסף שמייצג את כל המאפיינים המותאמים אישית של המסמך.
ProtectionTypeProtectionTypeקריאהמקבל את סוג ההגנה הפעיל של המסמך.
SectionsSectionCollectionקריאהמחזיר אוסף שמייצג את כל החלקים במסמך.
FirstSectionSectionקריאהמקבל את הקטע הראשון במסמך.
LastSectionSectionקריאהמקבל את הקטע האחרון במסמך.
ViewOptionsViewOptionsקריאהמספק אפשרויות לשליטה באופן שבו המסמך מוצג ב-Microsoft Word.
WriteProtectionWriteProtectionקריאהמספק גישה לאפשרויות הגנת כתיבה של המסמך.
CompatibilityOptionsCompatibilityOptionsקריאהמספק גישה לאפשרויות התאימות של המסמך (כלומר, ההעדפות שהמשתמש הזין בלשונית Compatibility בתיבת הדו-שיח Options ב-Word).
MailMergeSettingsMailMergeSettingsקריאה/כתיבהמקבל או מגדיר את האובייקט שמכיל את כל מידע המיזוג הדואר של מסמך.
HyphenationOptionsHyphenationOptionsקריאהמספק גישה לאפשרויות ההיפנציה של המסמך.
HasRevisionsboolקריאהמחזיר true אם למסמך יש שינויים במעקב.
HasMacrosboolקריאהמחזיר true אם למסמך יש פרויקט VBA (מאקרו).
WatermarkWatermarkקריאהמספק גישה לסימן המים של המסמך.
VersionsCountintקריאהמקבל את מספר גרסאות המסמך שנשמרו במסמך DOC.
DefaultTabStopdoubleקריאה/כתיבהמקבל או מגדיר את המרווח (בנקודות) בין עצירות הטאבים המוגדרות כברירת מחדל.
ThemeThemeקריאהמקבל את אובייקט Theme עבור מסמך זה.
CustomXmlPartsCustomXmlPartCollectionקריאה/כתיבהמקבל או מגדיר את האוסף של חלקי אחסון נתונים מותאמים אישית XML.
PackageCustomPartsCustomPartCollectionקריאה/כתיבהמקבל או מגדיר את האוסף של חלקים מותאמים (תוכן שרירותי) המקושרים לחבילת OOXML באמצעות “unknown relationships”.
VariablesVariableCollectionקריאהמחזיר את האוסף של המשתנים שנוספו למסמך או לתבנית.
GlossaryDocumentGlossaryDocumentקריאה/כתיבהמקבל או מגדיר את מסמך המונון בתוך מסמך זה או בתבנית.
OriginalFileNamestringקריאהמקבל את שם הקובץ המקורי של המסמך.
OriginalLoadFormatLoadFormatקריאהמקבל את פורמט המסמך המקורי שהוטען לאובייקט זה.
ComplianceOoxmlComplianceקריאהמקבל את גרסת ההתאימות ל-OOXML שנקבעה מתוך תוכן המסמך שהוטען.
DigitalSignaturesDigitalSignatureCollectionקריאהמקבל את האוסף של החתימות הדיגיטליות למסמך זה ואת תוצאות האימות שלהן.
FontSettingsFontSettingsקריאה/כתיבהמקבל או מגדיר את הגדרות הגופן של המסמך.
BibliographyBibliography.Bibliographyקריאהמקבל את אובייקט Bibliography שמייצג את רשימת המקורות הזמינים במסמך.
FramesetFramesetקריאהמחזיר מופע של Frameset אם המסמך הזה מייצג דף מסגרות.
IncludeTextboxesFootnotesEndnotesInStatboolקריאה/כתיבהקובע האם לכלול תיבות טקסט, הערות שוליים והערות סופיות בסטטיסטיקות של ספירת מילים.
RevisionsRevisionCollectionקריאהמקבל אוסף של גרסאות (שינויים במעקב) הקיימות במסמך זה.
RevisionsViewRevisionsViewקריאה/כתיבהמקבל או מגדיר ערך המציין האם לעבוד עם הגרסה המקורית או עם הגרסה המתוקנת של מסמך.
JustificationModeJustificationModeקריאה/כתיבהמקבל או מגדיר את התאמת ריווח התווים של מסמך.
FootnoteOptionsFootnoteOptionsקריאהמספק אפשרויות השולטות במספור ובמיקום של הערות שוליים במסמך זה.
EndnoteOptionsEndnoteOptionsקריאהמספק אפשרויות השולטות במספור ובמיקום של הערות סיום במסמך זה.
FieldOptionsFieldOptionsקריאהמקבל אובייקט FieldOptions שמייצג אפשרויות לשליטה בטיפול בשדות במסמך.
RemovePersonalInformationboolקריאה/כתיבהמקבל או מגדיר דגל שמצביע על כך ש-Microsoft Word יסיר את כל המידע על המשתמש מההערות, הגרסאות ותכונות המסמך בעת שמירת המסמך.
VbaProjectVbaProjectקריאה/כתיבהמקבל או מגדיר VbaProject.
DocumentDocumentBaseקריאהמקבל את המופע הזה.
NodeChangingCallbackINodeChangingCallbackקריאה/כתיבהנקרא כאשר צומת מתווסף או מוסר במסמך.
ResourceLoadingCallbackIResourceLoadingCallbackקריאה/כתיבהמאפשר לשלוט באופן שבו משאבים חיצוניים נטענים.
FontInfosFontInfoCollectionקריאהמספק גישה למאפייני הגופנים המשמשים במסמך זה.
StylesStyleCollectionקריאהמחזיר אוסף של סגנונות המוגדרים במסמך.
ListsListCollectionקריאהמספק גישה לעיצוב הרשימות המשמש במסמך.
WarningCallbackIWarningCallbackקריאה/כתיבהנקרא במהלך פרוצדורות עיבוד שונות של המסמך כאשר מתגלה בעיה שעשויה לגרום לאובדן דיוק בנתונים או בעיצוב.
FootnoteSeparatorsFootnoteSeparatorCollectionקריאהמספק גישה למפרידי ההערות השוליות/הערות הסיום המוגדרים במסמך.
BackgroundShapeShapeקריאה/כתיבהמקבל או מגדיר את צורת הרקע של המסמך.
PageColorColorקריאה/כתיבהמקבל או מגדיר את צבע העמוד של המסמך.
IsCompositeboolקריאהמחזיר true מכיוון שהצומת הזה יכול להכיל צמתים ילדים.
HasChildNodesboolקריאהמחזיר true אם ל-node הזה יש צמתים בנים.
FirstChildNodeקריאהמקבל את הילד הראשון של הצומת.
LastChildNodeקריאהמקבל את הילד האחרון של הצומת.
Countintקריאהמקבל את מספר הילדים הישירים של הצומת הזה.
ParentNodeCompositeNodeקריאהמקבל את ההורה הישיר של הצומת הזה.
PreviousSiblingNodeקריאהמקבל את הצומת שממוקמת מיד לפני הצומת הזה.
NextSiblingNodeקריאהמקבל את הצומת המיידי אחרי צומת זה.
RangeRangeקריאהמחזיר אובייקט Range המייצג את החלק של המסמך שנמצא בתוך צומת זה.
CustomNodeIdintקריאה/כתיבהמציין מזהה צומת מותאם אישית.

שיטות

חתימהתיאור
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 של סוג הצומת למחרוזת ידידותית למשתמש.

ראה גם

 עברית