StructuredDocumentTag
StructuredDocumentTag
نمای کلی
StructuredDocumentTag یک کلاس در Aspose.Words FOSS برای .NET است. ارث می‌برد از: CompositeNode، IMarkupNode، ITrackableNode و ۲ مورد دیگر.
نمایانگر یک برچسب سند ساختار یافته (SDT یا کنترل محتوا) در یک سند است.
این کلاس 31 متد برای کار با اشیاء StructuredDocumentTag در برنامه‌های .NET ارائه می‌دهد. متدهای موجود شامل: Accept، AcceptEnd، AcceptStart، AppendChild، Clear، Clone، CreateNavigator، GetAncestor، GetAncestorOf، GetChild، GetChildNodes، GetEnumerator و 19 متد دیگر. همهٔ اعضای عمومی پس از نصب بستهٔ Aspose.Words FOSS برای .NET، برای هر برنامهٔ .NET قابل دسترسی هستند. ویژگی‌ها: Appearance، BuildingBlockCategory، BuildingBlockGallery، CalendarType، Checked، Color و 38 مورد دیگر.
خواص
| نام | نوع | دسترسی | توضیح |
|---|---|---|---|
NodeType | NodeType | خواندن | باز می‌گرداند StructuredDocumentTag. |
Placeholder | BuildingBlock | خواندن | دریافت می‌کند BuildingBlock که شامل متن جایگزین است و باید زمانی که محتوای این اجرای SDT خالی باشد، نمایش داده شود؛ عنصر XML مرتبط خالی است همان‌طور که از طریق عنصر XmlMapping مشخص شده یا عنصر IsShowingPlaceholderText برابر true باشد. |
PlaceholderName | string | خواندن/نوشتن | دریافت یا تنظیم نام BuildingBlock که متن جای‌گیر را شامل می‌شود. |
Level | MarkupLevel | خواندن | دریافت سطحی که این SDT در درخت سند رخ می‌دهد. |
SdtType | SdtType | خواندن | نوع این Structured document tag را دریافت می‌کند. |
Id | int | خواندن | یک شناسه عددی منحصر به‌فرد، فقط‌خواندنی و پایدار برای این SDT مشخص می‌کند. |
LockContentControl | bool | خواندن/نوشتن | هنگامی که به true تنظیم شود، این ویژگی مانع حذف این SDT توسط کاربر می‌شود. |
LockContents | bool | خواندن/نوشتن | هنگامی که به true تنظیم شود، این ویژگی مانع ویرایش محتوای این SDT توسط کاربر می‌شود. |
IsShowingPlaceholderText | bool | خواندن/نوشتن | مشخص می‌کند که آیا محتوای این SDT باید به‌عنوان متن جای‌دار تفسیر شود (برخلاف محتوای متن عادی داخل SDT). |
Tag | string | خواندن/نوشتن | برچسبی را که با گرهٔ فعلی SDT مرتبط است، مشخص می‌کند. |
ContentsFont | Font | خواندن | قالب‌بندی قلمی که بر متنی که به SDT وارد می‌شود اعمال خواهد شد. |
EndCharacterFont | Font | خواندن | قالب‌بندی قلمی که بر آخرین کاراکتر متنی که به SDT وارد می‌شود اعمال خواهد شد. |
IsTemporary | bool | خواندن/نوشتن | مشخص می‌کند که آیا این SDT هنگام تغییر محتوا باید از سند WordProcessingML حذف شود یا نه. |
Title | string | خواندن/نوشتن | نام کاربرپسند مرتبط با این SDT را مشخص می‌کند. |
ListItems | SdtListItemCollection | خواندن | دریافت می‌کند SdtListItemCollection مرتبط با این SDT. |
Checked | bool | خواندن/نوشتن | دریافت/تنظیم وضعیت فعلی Checkbox SDT. |
Appearance | SdtAppearance | خواندن/نوشتن | دریافت/تنظیم ظاهر یک برچسب سند ساختاری. |
DateDisplayLocale | int | خواندن/نوشتن | امکان تنظیم/دریافت قالب زبان برای تاریخ نمایش داده شده در این SDT را فراهم می‌کند. |
DateDisplayFormat | string | خواندن/نوشتن | رشته‌ای که قالبی را که تاریخ‌ها در آن نمایش داده می‌شوند نشان می‌دهد. |
FullDate | DateTime | خواندن/نوشتن | تاریخ و زمان کامل آخرین بار وارد شده در این SDT را مشخص می‌کند. |
DateStorageFormat | SdtDateStorageFormat | خواندن/نوشتن | فرمت ذخیره‌سازی تاریخی که برای یک SDT تاریخ استفاده می‌شود را دریافت/تنظیم می‌کند وقتی که SDT به یک گره XML در مخزن داده‌های سند متصل باشد. |
CalendarType | SdtCalendarType | خواندن/نوشتن | نوع تقویم برای این SDT را مشخص می‌کند. |
BuildingBlockGallery | string | خواندن/نوشتن | نوع بلوک ساختاری برای این SDT را مشخص می‌کند. |
BuildingBlockCategory | string | خواندن/نوشتن | دسته‌بندی بلوک سازنده برای این گره SDT را تعیین می‌کند. |
Multiline | bool | خواندن/نوشتن | مشخص می‌کند که آیا این SDT اجازهٔ چندین خط متن را می‌دهد یا خیر. |
Color | System.Drawing.Color | خواندن/نوشتن | رنگ برچسب سند ساختاری را دریافت یا تنظیم می‌کند. |
Style | Style | خواندن/نوشتن | دریافت یا تنظیم Style از StructuredDocumentTag. |
StyleName | string | خواندن/نوشتن | دریافت یا تنظیم نام سبکی که به برچسب سند ساختاری اعمال شده است. |
XmlMapping | XmlMapping | خواندن | دریافت یک شیء که نگاشت این برچسب سند ساختاری به داده‌های XML در یک بخش سفارشی XML از سند جاری را نمایش می‌دهد. |
WordOpenXML | string | خواندن | دریافت یک رشته که XML موجود در گره را در قالب FlatOpc نشان می‌دهد. |
WordOpenXMLMinimal | string | خواندن | یک رشته دریافت می‌کند که XML موجود در گره را در قالب FlatOpc نشان می‌دهد. |
IsComposite | bool | خواندن | به‌دلیل این‌که این گره می‌تواند گره‌های فرزند داشته باشد، true برمی‌گرداند. |
HasChildNodes | bool | خواندن | اگر این گره دارای هرگونه گره فرزند باشد، true برمی‌گرداند. |
FirstChild | Node | خواندن | اولین فرزند گره را دریافت می‌کند. |
LastChild | Node | خواندن | آخرین فرزند گره را دریافت می‌کند. |
Count | int | خواندن | تعداد فرزندان مستقیم این گره را دریافت می‌کند. |
ParentNode | CompositeNode | خواندن | والد مستقیم این گره را دریافت می‌کند. |
Document | DocumentBase | خواندن | سندی را که این گره به آن تعلق دارد دریافت می‌کند. |
PreviousSibling | Node | خواندن | گره‌ای را که بلافاصله پیش از این گره قرار دارد، دریافت می‌کند. |
NextSibling | Node | خواندن | نود را که بلافاصله پس از این نود قرار دارد، دریافت می‌کند. |
Range | Range | خواندن | یک شی Range برمی‌گرداند که بخشی از سند را که در این گره قرار دارد نشان می‌دهد. |
CustomNodeId | int | خواندن/نوشتن | شناسه سفارشی node identifier را مشخص می‌کند. |
IsMultiSection | bool | خواندن | در صورتی که این نمونه یک برچسب مستند ساختاری محدوده‌دار (چندبخشی) باشد، مقدار true را برمی‌گرداند. |
Node | Node | خواندن | یک شیء Node را برمی‌گرداند که این رابط را پیاده‌سازی می‌کند. |
روش ها
| امضا | توضیح |
|---|---|
StructuredDocumentTag(doc: DocumentBase, type: SdtType, level: MarkupLevel) | یک نمونه جدید از کلاس Structured document tag را مقداردهی اولیه می‌کند. |
SetCheckedSymbol(characterCode: int, fontName: string) | نماد استفاده‌شده برای نمایش وضعیت انتخاب شده یک کنترل محتوای چک‌باکس را تنظیم می‌کند. |
SetUncheckedSymbol(characterCode: int, fontName: string) | نماد مورد استفاده برای نمایش وضعیت علامت‌نشده در کنترل محتوا جعبه‌تیک را تنظیم می‌کند. |
RemoveSelfOnly() | فقط این گره SDT را حذف می‌کند، اما محتوای آن را در داخل درخت سند حفظ می‌کند. |
Accept(visitor: DocumentVisitor) | متد VisitStructuredDocumentTagStart را فراخوانی می‌کند، سپس Accept را برای تمام گره‌های فرزند برچسب هوشمند صدا می‌زند و در انتها VisitStructuredDocumentTagEnd را فراخوانی می‌کند. |
Clear() | محتویات این برچسب سند ساختاریافته را پاک می‌کند و در صورت تعریف شدن، یک placeholder را نمایش می‌دهد. |
AcceptStart(visitor: DocumentVisitor) | یک بازدیدکننده را برای بازدید از آغاز StructuredDocumentTag می‌پذیرد. |
AcceptEnd(visitor: DocumentVisitor) | یک بازدیدکننده را برای بازدید از انتهای StructuredDocumentTag می‌پذیرد. |
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() | ناوبری را ایجاد می‌کند که می‌توان از آن برای پیمایش و خواندن گره‌ها استفاده کرد. |
Clone(isCloneChildren: bool) | باید overload Clone(bool, INodeCloningListener) را زمانی که کلون‌کردن گره بخشی از یک فرایند کلون‌کردن گره دیگر (معمولاً ترکیبی) است، استفاده کنید. |
GetAncestor(ancestorType: Type) | اولین جد از نوع شیء مشخص شده را دریافت می‌کند. |
GetAncestorOf() | متد GetAncestorOf را بر روی این نمونه StructuredDocumentTag فراخوانی می‌کند. |
Remove() | خود را از والد حذف می‌کند. |
NextPreOrder(rootNode: Node) | گره بعدی را بر اساس الگوریتم پیمایش پیش‌سفری درخت می‌گیرد. |
PreviousPreOrder(rootNode: Node) | گره قبلی را بر اساس الگوریتم پیمایش پیش‌سفری درخت می‌گیرد. |
ToString(saveFormat: SaveFormat) | محتویات گره را به صورت یک رشته در قالب مشخص‌شده صادر می‌کند. |
NodeTypeToString(nodeType: NodeType) | یک متد کمکی که مقدار enum نوع گره را به رشته‌ای کاربرپسند تبدیل می‌کند. |
