Class CustomDocumentProperties

Summary description for CustomDocumentProperties.

Inheritance
System.Object
CollectionBase<DocumentPropertyImpl>
CollectionBaseEx<DocumentPropertyImpl>
CustomDocumentProperties
Implements
System.Collections.Generic.IList<DocumentPropertyImpl>
System.Collections.Generic.ICollection<DocumentPropertyImpl>
System.Collections.Generic.IEnumerable<DocumentPropertyImpl>
System.Collections.IEnumerable
Inherited Members
Namespace: Syncfusion.XlsIO.Implementation.Collections
Assembly: Syncfusion.XlsIO.UWP.dll
Syntax
public class CustomDocumentProperties : CollectionBaseEx<DocumentPropertyImpl>, IList<DocumentPropertyImpl>, ICollection<DocumentPropertyImpl>, IEnumerable<DocumentPropertyImpl>, IEnumerable, IParentApplication, ICloneParent, ICustomDocumentProperties

Constructors

CustomDocumentProperties(IApplication, Object)

Default constructor.

Declaration
public CustomDocumentProperties(IApplication application, object parent)
Parameters
Type Name Description
IApplication application
System.Object parent

Fields

CustomGuidString

Custom guid string.

Declaration
public const string CustomGuidString = "D5CDD505-2E9C-101B-9397-08002B2CF9AE"
Field Value
Type
System.String

GuidCustom

Guid used for parsing/serialization of custom properties.

Declaration
public static readonly Guid GuidCustom
Field Value
Type
System.Guid

Properties

Item[String]

Returns single entry from the collection. Read-only.

Declaration
public IDocumentProperty this[string strName] { get; }
Parameters
Type Name Description
System.String strName
Property Value
Type
IDocumentProperty

Methods

Add(String)

Adds element to the collection.

Declaration
public IDocumentProperty Add(string strName)
Parameters
Type Name Description
System.String strName

Property name to add.
Returns
Type Description
IDocumentProperty

Newly created property.

Contains(String)

Checks whether collection contains property with specified name.

Declaration
public bool Contains(string strName)
Parameters
Type Name Description
System.String strName

Name to check.
Returns
Type Description
System.Boolean

True if property is contained by collection; false otherwise.

GetProperty(String)

Returns custom property by name.

Declaration
public IDocumentProperty GetProperty(string strName)
Parameters
Type Name Description
System.String strName

Custom property.
Returns
Type Description
IDocumentProperty

Custom property.

OnClearComplete()

OnClear is invoked after Clear behavior.

Declaration
protected override void OnClearComplete()
Overrides
Syncfusion.XlsIO.Implementation.Collections.CollectionBaseEx<Syncfusion.CompoundFile.XlsIO.DocumentPropertyImpl>.OnClearComplete()

Parse(DocumentPropertyCollection)

Extract custom document properties.

Declaration
public void Parse(DocumentPropertyCollection properties)
Parameters
Type Name Description
DocumentPropertyCollection properties

Remove(String)

Removes specified object from the collection.

Declaration
public void Remove(string strName)
Parameters
Type Name Description
System.String strName

Property name.

Serialize(PropertySection)

Serializes built-in properties.

Declaration
public void Serialize(PropertySection section)
Parameters
Type Name Description
PropertySection section

Explicit Interface Implementations

ICustomDocumentProperties.get_Item(Int32)

Declaration
IDocumentProperty ICustomDocumentProperties.get_Item(int iIndex)
Parameters
Type Name Description
System.Int32 iIndex
Returns
Type
IDocumentProperty

ICustomDocumentProperties.Item[Int32]

Returns single entry from the collection. Read-only.

Declaration
IDocumentProperty ICustomDocumentProperties.this[] { get; }
Parameters
Type Name Description
System.Int32 iIndex
Returns
Type
IDocumentProperty

Implements

System.Collections.Generic.IList<>
System.Collections.Generic.ICollection<>
System.Collections.Generic.IEnumerable<>
System.Collections.IEnumerable

Extension Methods