Class FormatBase

Represents the base formatting.

Inheritance

System.Object

OwnerHolder

XDLSSerializableBase

FormatBase

Border

Borders

CellFormat

Column

MarginsF

Paddings

PageNumbers

RowFormat

RowFormat.TablePositioning

TableStyleCellProperties

TableStyleRowProperties

TableStyleTableProperties

WCharacterFormat

WListFormat

WPageSetup

WParagraphFormat

WTextBoxFormat

Implements

IXDLSSerializable

Inherited Members

OwnerHolder.Document

OwnerHolder.m_doc

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

XDLSSerializableBase.CloneImpl()

XDLSSerializableBase.InitXDLSHolder()

XDLSSerializableBase.IXDLSSerializable.ReadXmlAttributes(IXDLSAttributeReader)

XDLSSerializableBase.IXDLSSerializable.ReadXmlContent(IXDLSContentReader)

XDLSSerializableBase.IXDLSSerializable.RestoreReference(String, Int32)

XDLSSerializableBase.IXDLSSerializable.WriteXmlAttributes(IXDLSAttributeWriter)

XDLSSerializableBase.IXDLSSerializable.WriteXmlContent(IXDLSContentWriter)

XDLSSerializableBase.IXDLSSerializable.XDLSHolder

XDLSSerializableBase.ReadXmlAttributes(IXDLSAttributeReader)

XDLSSerializableBase.ReadXmlContent(IXDLSContentReader)

XDLSSerializableBase.RestoreReference(String, Int32)

XDLSSerializableBase.WriteXmlAttributes(IXDLSAttributeWriter)

XDLSSerializableBase.WriteXmlContent(IXDLSContentWriter)

XDLSSerializableBase.XDLSHolder

Namespace: Syncfusion.DocIO.DLS

Assembly: Syncfusion.DocIO.Base.dll

Syntax

public abstract class FormatBase : XDLSSerializableBase, IXDLSSerializable

Constructors

FormatBase()

Initializes a new instance of the FormatBase class.

Declaration

public FormatBase()

FormatBase(FormatBase, Int32)

Initializes a new instance of the FormatBase class.

Declaration

public FormatBase(FormatBase parentFormat, int parentKey)

Parameters

Type	Name	Description
FormatBase	parentFormat	The FormatBase that represents the parent format.
System.Int32	parentKey	The integer that represents the parent key.

FormatBase(FormatBase, Int32, Int32)

Initializes a new instance of the FormatBase class.

Declaration

public FormatBase(FormatBase parent, int parentKey, int parentOffset)

Parameters

Type	Name	Description
FormatBase	parent	The FormatBase that represents the parent format.
System.Int32	parentKey	The integer that represents the parent key.
System.Int32	parentOffset	The integer that represents the parent offset.

FormatBase(IWordDocument)

Initializes a new instance of the FormatBase class.

Declaration

public FormatBase(IWordDocument doc)

Parameters

Type	Name	Description
IWordDocument	doc	The WordDocument object.

FormatBase(IWordDocument, Entity)

Initializes a new instance of the FormatBase class.

Declaration

public FormatBase(IWordDocument doc, Entity owner)

Parameters

Type	Name	Description
IWordDocument	doc	The WordDocument object.
Entity	owner	The Entity that is the owner of the current item.

Fields

BaseLineAlignmentAuto

Represents automatic baseline alignment (BaseLineAlignment.Auto). This field is read-only.

Declaration

protected static readonly object BaseLineAlignmentAuto

Field Value

Type
System.Object

BorderStyleNone

Represents no border style (BorderStyle.None). This field is read-only.

Declaration

protected static readonly object BorderStyleNone

Field Value

Type
System.Object

BreakClearNone

Represents no break clear behavior (BreakClearType.None). This field is read-only.

Declaration

protected static readonly object BreakClearNone

Field Value

Type
System.Object

ByteMax

Represents the maximum 8-bit unsigned integer value. This field is read-only.

Declaration

protected static readonly object ByteMax

Field Value

Type
System.Object

CellMergeNone

Represents no cell merge (CellMerge.None). This field is read-only.

Declaration

protected static readonly object CellMergeNone

Field Value

Type
System.Object

ChapterPageSeparatorTypeHyphen

Represents hyphen chapter-page separator (ChapterPageSeparatorType.Hyphen). This field is read-only.

Declaration

protected static readonly object ChapterPageSeparatorTypeHyphen

Field Value

Type
System.Object

DefFontSizeSingle

Represents the default font size as a single-precision floating-point value. This field is read-only.

Declaration

protected static readonly object DefFontSizeSingle

Field Value

Type
System.Object

DefScalingSizeSingle

Represents the default scaling size from WCharacterFormat as a single-precision value. This field is read-only.

Declaration

protected static readonly object DefScalingSizeSingle

Field Value

Type
System.Object

DocTextDirectionLeftToRight

Represents left-to-right document text direction (DocTextDirection.LeftToRight). This field is read-only.

Declaration

protected static readonly object DocTextDirectionLeftToRight

Field Value

Type
System.Object

DropCapNone

Represents no drop cap (DropCapType.None). This field is read-only.

Declaration

protected static readonly object DropCapNone

Field Value

Type
System.Object

EighteenSingle

Represents the single-precision floating-point value 18.0. This field is read-only.

Declaration

protected static readonly object EighteenSingle

Field Value

Type
System.Object

EmphasisNone

Represents no emphasis (EmphasisType.NoEmphasis). This field is read-only.

Declaration

protected static readonly object EmphasisNone

Field Value

Type
System.Object

EmptyColor

Represents an empty Color value. This field is read-only.

Declaration

protected static readonly object EmptyColor

Field Value

Type
System.Object

EmptyString

Represents an empty string. This field is read-only.

Declaration

protected static readonly object EmptyString

Field Value

Type
System.Object

EndnotePosEndOfDoc

Represents endnotes displayed at end of document (EndnotePosition.DisplayEndOfDocument). This field is read-only.

Declaration

protected static readonly object EndnotePosEndOfDoc

Field Value

Type
System.Object

EndnoteRestartDoNot

Represents no restart for endnotes (EndnoteRestartIndex.DoNotRestart). This field is read-only.

Declaration

protected static readonly object EndnoteRestartDoNot

Field Value

Type
System.Object

False

Represents the Boolean false value. This field is read-only.

Declaration

protected static readonly object False

Field Value

Type
System.Object

FontHintDefault

Represents the default font hint (FontHintType.Default). This field is read-only.

Declaration

protected static readonly object FontHintDefault

Field Value

Type
System.Object

FootEndNoteNumberFormatArabic

Represents Arabic foot/endnote number format (FootEndNoteNumberFormat.Arabic). This field is read-only.

Declaration

protected static readonly object FootEndNoteNumberFormatArabic

Field Value

Type
System.Object

FootEndNoteNumberFormatLowerCaseRoman

Represents lowercase Roman foot/endnote number format (FootEndNoteNumberFormat.LowerCaseRoman). This field is read-only.

Declaration

protected static readonly object FootEndNoteNumberFormatLowerCaseRoman

Field Value

Type
System.Object

FootnotePosBottomOfPage

Represents footnotes printed at bottom of page (FootnotePosition.PrintAtBottomOfPage). This field is read-only.

Declaration

protected static readonly object FootnotePosBottomOfPage

Field Value

Type
System.Object

FrameWrapAuto

Represents automatic frame wrapping (FrameWrapMode.Auto). This field is read-only.

Declaration

protected static readonly object FrameWrapAuto

Field Value

Type
System.Object

FtsWidthNone

Represents no fixed table width (FtsWidth.None). This field is read-only.

Declaration

protected static readonly object FtsWidthNone

Field Value

Type
System.Object

GridPitchNoGrid

Represents no grid pitch (GridPitchType.NoGrid). This field is read-only.

Declaration

protected static readonly object GridPitchNoGrid

Field Value

Type
System.Object

HeadingLevelNone

Represents no heading level (HeadingLevel.None). This field is read-only.

Declaration

protected static readonly object HeadingLevelNone

Field Value

Type
System.Object

HorizontalAlignmentLeft

Represents left horizontal alignment (HorizontalAlignment.Left). This field is read-only.

Declaration

protected static readonly object HorizontalAlignmentLeft

Field Value

Type
System.Object

HorizontalRelationColumn

Represents horizontal relation to column (HorizontalRelation.Column). This field is read-only.

Declaration

protected static readonly object HorizontalRelationColumn

Field Value

Type
System.Object

IntMaxValue

Represents the maximum 32-bit integer value. This field is read-only.

Declaration

protected static readonly object IntMaxValue

Field Value

Type
System.Object

LigatureNone

Represents no ligatures (LigatureType.None). This field is read-only.

Declaration

protected static readonly object LigatureNone

Field Value

Type
System.Object

LineNumberingNone

Represents no line numbering (LineNumberingMode.None). This field is read-only.

Declaration

protected static readonly object LineNumberingNone

Field Value

Type
System.Object

LineSpacingRuleMultiple

Represents multiple line spacing rule (LineSpacingRule.Multiple). This field is read-only.

Declaration

protected static readonly object LineSpacingRuleMultiple

Field Value

Type
System.Object

ListTypeNoList

Represents no list formatting (ListType.NoList). This field is read-only.

Declaration

protected static readonly object ListTypeNoList

Field Value

Type
System.Object

m_oldPropertiesHash

Member to hold the collection of old properties values and its keys.

Declaration

protected Dictionary<int, object> m_oldPropertiesHash

Field Value

Type
System.Collections.Generic.Dictionary<System.Int32, System.Object>

m_propertiesHash

Member to hold the collection of properties values and its keys.

Declaration

protected Dictionary<int, object> m_propertiesHash

Field Value

Type
System.Collections.Generic.Dictionary<System.Int32, System.Object>

MinDateTime

Represents the minimum DateTime value. This field is read-only.

Declaration

protected static readonly object MinDateTime

Field Value

Type
System.Object

MinusOneSingle

Represents the single-precision floating-point value -1.0. This field is read-only.

Declaration

protected static readonly object MinusOneSingle

Field Value

Type
System.Object

NumberFormDefault

Represents the default number form (NumberFormType.Default). This field is read-only.

Declaration

protected static readonly object NumberFormDefault

Field Value

Type
System.Object

NumberSpacingDefault

Represents the default number spacing (NumberSpacingType.Default). This field is read-only.

Declaration

protected static readonly object NumberSpacingDefault

Field Value

Type
System.Object

OneInt

Represents the 32-bit integer value 1. This field is read-only.

Declaration

protected static readonly object OneInt

Field Value

Type
System.Object

OneShort

Represents the 16-bit integer value 1. This field is read-only.

Declaration

protected static readonly object OneShort

Field Value

Type
System.Object

PageAlignTop

Represents top page alignment (PageAlignment.Top). This field is read-only.

Declaration

protected static readonly object PageAlignTop

Field Value

Type
System.Object

PageBorderOffsetText

Represents page border offset from text (PageBorderOffsetFrom.Text). This field is read-only.

Declaration

protected static readonly object PageBorderOffsetText

Field Value

Type
System.Object

PageBordersApplyAll

Represents page borders applied to all pages (PageBordersApplyType.AllPages). This field is read-only.

Declaration

protected static readonly object PageBordersApplyAll

Field Value

Type
System.Object

PageNumberStyleArabic

Represents Arabic page number style (PageNumberStyle.Arabic). This field is read-only.

Declaration

protected static readonly object PageNumberStyleArabic

Field Value

Type
System.Object

PageOrientPortrait

Represents portrait page orientation (PageOrientation.Portrait). This field is read-only.

Declaration

protected static readonly object PageOrientPortrait

Field Value

Type
System.Object

RowAlignmentCenter

Represents center row alignment (RowAlignment.Center). This field is read-only.

Declaration

protected static readonly object RowAlignmentCenter

Field Value

Type
System.Object

RowAlignmentLeft

Represents left row alignment (RowAlignment.Left). This field is read-only.

Declaration

protected static readonly object RowAlignmentLeft

Field Value

Type
System.Object

RowAlignmentRight

Represents right row alignment (RowAlignment.Right). This field is read-only.

Declaration

protected static readonly object RowAlignmentRight

Field Value

Type
System.Object

SectionBreakCodeNewPage

Represents a section break to a new page (SectionBreakCode.NewPage). This field is read-only.

Declaration

protected static readonly object SectionBreakCodeNewPage

Field Value

Type
System.Object

Short1025

Represents the 16-bit culture identifier 1025 (ar-SA default, BiDi). This field is read-only.

Declaration

protected static readonly object Short1025

Field Value

Type
System.Object

Short1033

Represents the 16-bit culture identifier 1033 (en-US default, ASCII/FarEast). This field is read-only.

Declaration

protected static readonly object Short1033

Field Value

Type
System.Object

SizeFObj

Represents a default-initialized SizeF value. This field is read-only.

Declaration

protected static readonly object SizeFObj

Field Value

Type
System.Object

StylisticSetDefault

Represents the default stylistic set (StylisticSetType.StylisticSetDefault). This field is read-only.

Declaration

protected static readonly object StylisticSetDefault

Field Value

Type
System.Object

SubSuperScriptNone

Represents no subscript/superscript (SubSuperScript.None). This field is read-only.

Declaration

protected static readonly object SubSuperScriptNone

Field Value

Type
System.Object

TextDirectionHorizontal

Represents horizontal text direction (TextDirection.Horizontal). This field is read-only.

Declaration

protected static readonly object TextDirectionHorizontal

Field Value

Type
System.Object

TextEffectNone

Represents no text effect (TextEffect.None). This field is read-only.

Declaration

protected static readonly object TextEffectNone

Field Value

Type
System.Object

TextureStyleNone

Represents no texture style (TextureStyle.TextureNone). This field is read-only.

Declaration

protected static readonly object TextureStyleNone

Field Value

Type
System.Object

TightWrapNone

Represents no tight wrap for textboxes (TextboxTightWrapOptions.None). This field is read-only.

Declaration

protected static readonly object TightWrapNone

Field Value

Type
System.Object

True

Represents the Boolean true value. This field is read-only.

Declaration

protected static readonly object True

Field Value

Type
System.Object

TwelveSingle

Represents the single-precision floating-point value 12.0. This field is read-only.

Declaration

protected static readonly object TwelveSingle

Field Value

Type
System.Object

TwentySingle

Represents the single-precision floating-point value 20.0. This field is read-only.

Declaration

protected static readonly object TwentySingle

Field Value

Type
System.Object

UnderlineNone

Represents no underline (UnderlineStyle.None). This field is read-only.

Declaration

protected static readonly object UnderlineNone

Field Value

Type
System.Object

VerticalAlignmentTop

Represents top vertical alignment (VerticalAlignment.Top). This field is read-only.

Declaration

protected static readonly object VerticalAlignmentTop

Field Value

Type
System.Object

VerticalRelationMargin

Represents vertical relation to margin (VerticalRelation.Margin). This field is read-only.

Declaration

protected static readonly object VerticalRelationMargin

Field Value

Type
System.Object

ZeroByte

Represents the 8-bit unsigned integer value 0. This field is read-only.

Declaration

protected static readonly object ZeroByte

Field Value

Type
System.Object

ZeroInt

Represents the 32-bit integer value 0. This field is read-only.

Declaration

protected static readonly object ZeroInt

Field Value

Type
System.Object

ZeroLong

Represents the 64-bit integer value 0. This field is read-only.

Declaration

protected static readonly object ZeroLong

Field Value

Type
System.Object

ZeroSingle

Represents the single-precision floating-point value 0.0. This field is read-only.

Declaration

protected static readonly object ZeroSingle

Field Value

Type
System.Object

Properties

Item[Int32]

Gets or sets the value for the property with specified key.

Declaration

protected object this[int key] { get; set; }

Parameters

Type	Name	Description
System.Int32	key	The key for the property.

Property Value

Type	Description
System.Object	An object with the specific key.

Methods

ClearFormatting()

Clears the formatting.

Declaration

public virtual void ClearFormatting()

EnsureComposites()

Ensures the composites.

Declaration

protected virtual void EnsureComposites()

EnsureComposites(Int32[])

Ensures the composites.

Declaration

protected void EnsureComposites(params int[] keys)

Parameters

Type	Name	Description
System.Int32[]	keys	The keys of the properties.

GetBaseKey(Int32)

Returns the key of the base format.

Declaration

protected int GetBaseKey(int key)

Parameters

Type	Name	Description
System.Int32	key	The integer which specifies the key.

Returns

Type	Description
System.Int32	The key of the parent format.

GetDefComposite(Int32)

Gets the composite values.

Declaration

protected virtual FormatBase GetDefComposite(int key)

Parameters

Type	Name	Description
System.Int32	key	The integer that specifies the key.

Returns

Type	Description
FormatBase	The FormatBase object.

GetDefComposite(Int32, FormatBase)

Returns the default composite value.

Declaration

protected FormatBase GetDefComposite(int key, FormatBase value)

Parameters

Type	Name	Description
System.Int32	key	The integer that specifies the key.
FormatBase	value	The FormatBase object.

Returns

Type	Description
FormatBase	The FormatBase element.

GetDefValue(Int32)

Returns the default values.

Declaration

protected abstract object GetDefValue(int key)

Parameters

Type	Name	Description
System.Int32	key	The integer that specifies the key.

Returns

Type	Description
System.Object	An object that specifies the default value.

GetFullKey(Int32)

Returns the whole key.

Declaration

protected int GetFullKey(int key)

Parameters

Type	Name	Description
System.Int32	key	The integer that specifies the key.

Returns

Type	Description
System.Int32	The entire key.

HasBoolKey(Int32)

Returns a value indicating whether the key exists and its corresponding boolean value.

Declaration

public bool HasBoolKey(int key)

Parameters

Type	Name	Description
System.Int32	key	The integer that specifies the key.

Returns

Type	Description
System.Boolean	True if the specified key is present with its boolean value, otherwise false.

HasKey(Int32)

Returns the value indicating whether the key exists in the properties collection.

Declaration

public bool HasKey(int key)

Parameters

Type	Name	Description
System.Int32	key	The integer that specifies the key.

Returns

Type	Description
System.Boolean	True if the specified key is present, otherwise false.

ImportContainer(FormatBase)

Imports the container.

Declaration

protected void ImportContainer(FormatBase format)

Parameters

Type	Name	Description
FormatBase	format	The format.

ImportMembers(FormatBase)

Imports the members.

Declaration

protected virtual void ImportMembers(FormatBase format)

Parameters

Type	Name	Description
FormatBase	format	The FormatBase object.

OnChange(FormatBase, Int32)

Occurs on format change.

Declaration

protected virtual void OnChange(FormatBase format, int propKey)

Parameters

Type	Name	Description
FormatBase	format	The FormatBase object.
System.Int32	propKey	The integer that represents the property key.

Implements

IXDLSSerializable