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
Inherited Members
Namespace: Syncfusion.DocIO.DLS
Assembly: Syncfusion.DocIO.NET.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

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>

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