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 متد دیگر. تمام اعضای عمومی پس از نصب بسته Aspose.Words FOSS برای .NET، برای هر برنامه .NET در دسترس هستند. ویژگی‌ها: AttachedTemplate، AutomaticallyUpdateStyles، BackgroundShape، Bibliography، BuiltInDocumentProperties، CompatibilityOptions و 62 مورد دیگر.

خواص

نام	نوع	دسترسی	توضیح
`AttachedTemplate`	`string`	خواندن/نوشتن	مسیر کامل الگوی پیوست‌شده به سند را دریافت یا تنظیم می‌کند.
`AutomaticallyUpdateStyles`	`bool`	خواندن/نوشتن	پرچمی را دریافت یا تنظیم می‌کند که نشان می‌دهد آیا سبک‌های سند هر بار که در MS Word باز می‌شود، برای تطبیق با سبک‌های الگوی پیوست‌شده به‌روزرسانی می‌شوند یا نه.
`ShadeFormData`	`bool`	خواندن/نوشتن	مشخص می‌کند که آیا سایه‌گذاری خاکستری روی فیلدهای فرم فعال شود.
`TrackRevisions`	`bool`	خواندن/نوشتن	True اگر تغییرات هنگام ویرایش این سند در Microsoft Word ردیابی شوند.
`ShowGrammaticalErrors`	`bool`	خواندن/نوشتن	مشخص می‌کند که آیا خطاهای گرامری در این سند نمایش داده شوند.
`ShowSpellingErrors`	`bool`	خواندن/نوشتن	مشخص می‌کند که آیا خطاهای املایی در این سند نمایش داده شوند یا خیر.
`SpellingChecked`	`bool`	خواندن/نوشتن	اگر سند برای املاء بررسی شده باشد، مقدار true را برمی‌گرداند.
`GrammarChecked`	`bool`	خواندن/نوشتن	اگر سند برای دستور زبان بررسی شده باشد، مقدار true را برمی‌گرداند.
`PunctuationKerning`	`bool`	خواندن/نوشتن	مشخص می‌کند که آیا کرنینگ بر هر دو متن لاتین و نقطه‌گذاری اعمال می‌شود.
`NodeType`	`NodeType`	خواندن	سند را برمی‌گرداند.
`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`	خواندن/نوشتن	دریافت یا تنظیم شیئی که شامل تمام اطلاعات mail merge برای یک سند است.
`HyphenationOptions`	`HyphenationOptions`	خواندن	دسترسی به گزینه‌های hyphenation سند را فراهم می‌کند.
`HasRevisions`	`bool`	خواندن	اگر سند دارای هر گونه tracked changes باشد، true را برمی‌گرداند.
`HasMacros`	`bool`	خواندن	در صورتی که سند پروژه VBA (ماکروها) داشته باشد، true برمی‌گرداند.
`Watermark`	`Watermark`	خواندن	دسترسی به آب‌نشان سند را فراهم می‌کند.
`VersionsCount`	`int`	خواندن	تعداد نسخه‌های سندی که در سند DOC ذخیره شده بود را دریافت می‌کند.
`DefaultTabStop`	`double`	خواندن/نوشتن	دریافت یا تنظیم فاصله (به نقطه) بین توقف‌های پیش‌فرض تب.
`Theme`	`Theme`	خواندن	شیء Theme را برای این سند دریافت می‌کند.
`CustomXmlParts`	`CustomXmlPartCollection`	خواندن/نوشتن	دریافت یا تنظیم مجموعه‌ای از بخش‌های ذخیره‌سازی داده‌های سفارشی XML.
`PackageCustomParts`	`CustomPartCollection`	خواندن/نوشتن	دریافت یا تنظیم مجموعه‌ای از بخش‌های سفارشی (محتوای دلخواه) که با استفاده از “unknown relationships” به بسته OOXML پیوند داده شده‌اند.
`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 را برمی‌گرداند.
`FirstChild`	`Node`	خواندن	اولین فرزند گره را برمی‌گرداند.
`LastChild`	`Node`	خواندن	آخرین فرزند گره را دریافت می‌کند.
`Count`	`int`	خواندن	تعداد فرزندان مستقیم این گره را دریافت می‌کند.
`ParentNode`	`CompositeNode`	خواندن	والد مستقیم این گره را دریافت می‌کند.
`PreviousSibling`	`Node`	خواندن	گره‌ای که بلافاصله قبل از این گره است را برمی‌گرداند.
`NextSibling`	`Node`	خواندن	گره‌ای که بلافاصله پس از این node قرار دارد را برمی‌گرداند.
`Range`	`Range`	خواندن	یک شیء Range را برمی‌گرداند که بخشی از سند را که در این گره قرار دارد، نشان می‌دهد.
`CustomNodeId`	`int`	خواندن/نوشتن	شناسهٔ سفارشی گره را مشخص می‌کند.

روش ها

امضا	توضیح
`Document()`	یک سند را ایجاد یا بارگذاری می‌کند.
`Document(fileName: string)`	یک سند موجود را از فایل باز می‌کند.
`Document(fileName: string, loadOptions: LoadOptions)`	یک سند موجود را از فایل باز می‌کند.
`Document(stream: Stream)`	متد Document(stream) را بر روی این نمونه Document صدا می‌زند.
`Document(stream: Stream, loadOptions: LoadOptions)`	متد Document(stream, loadOptions) را بر روی این نمونه Document صدا می‌زند.
`Clone()`	یک کپی عمیق از Document انجام می‌دهد.
`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)`	Overloads امکان ذخیره‌سازی سند به نام فایل یا یک جریان را فراهم می‌کنند، به‌طور اختیاری می‌توانید فرمت ذخیره یا گزینه‌های ذخیره‌سازی دقیق را مشخص کنید.
`Save(stream: Stream, saveOptions: SaveOptions)`	متد Save(stream, saveOptions) را بر روی این نمونه Document فراخوانی می‌کند.
`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)`	گرهٔ فرزند Nام که با نوع مشخص شده مطابقت دارد را برمی‌گرداند.
`SelectNodes(xpath: string)`	یک فهرست از گره‌هایی که با عبارت XPath مطابقت دارند، انتخاب می‌کند.
`SelectSingleNode(xpath: string)`	اولین گره‌ای که با عبارت 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 نوع گره را به یک رشته کاربرپسند تبدیل می‌کند.

همچنین ببینید:

Aspose.Words for .NET — Enterprise API Reference