Class BuiltInDocumentProperties
Represents the document properties in a MS Excel document.
Inheritance
Implements
Inherited Members
Namespace: Syncfusion.XlsIO.Implementation.Collections
Assembly: Syncfusion.XlsIO.Portable.dll
Syntax
public class BuiltInDocumentProperties : CollectionBaseEx<DocumentPropertyImpl>, IList<DocumentPropertyImpl>, ICollection<DocumentPropertyImpl>, IEnumerable<DocumentPropertyImpl>, IEnumerable, IParentApplication, ICloneParent, IBuiltInDocumentPropertiesConstructors
BuiltInDocumentProperties(IApplication, Object)
Creates a new instance for Builtin documentation properties.
Declaration
public BuiltInDocumentProperties(IApplication application, object parent)Parameters
| Type | Name | Description |
|---|---|---|
| IApplication | application | Application object for this collection. |
| System.Object | parent | Parent object for this collection. |
Fields
GuidDocument
Guid for parsing/serialization document properties.
Declaration
public static readonly Guid GuidDocumentField Value
| Type |
|---|
| System.Guid |
GuidSummary
Guid for parsing/serialization summary properties.
Declaration
public static readonly Guid GuidSummaryField Value
| Type |
|---|
| System.Guid |
Properties
ApplicationName
Gets or sets application name of the document.
Declaration
public string ApplicationName { get; set; }Property Value
| Type |
|---|
| System.String |
Author
Gets or sets author of the document.
Declaration
public string Author { get; set; }Property Value
| Type |
|---|
| System.String |
ByteCount
Gets or sets byte count of the document.
Declaration
public int ByteCount { get; set; }Property Value
| Type |
|---|
| System.Int32 |
Category
Gets or sets category of the document.
Declaration
public string Category { get; set; }Property Value
| Type |
|---|
| System.String |
CharCount
Gets or sets character count of the document.
Declaration
public int CharCount { get; set; }Property Value
| Type |
|---|
| System.Int32 |
Comments
Gets or sets comments of the document.
Declaration
public string Comments { get; set; }Property Value
| Type |
|---|
| System.String |
Company
Gets or sets company of the document.
Declaration
public string Company { get; set; }Property Value
| Type |
|---|
| System.String |
CreationDate
Gets or sets creation date of the document.
Declaration
public DateTime CreationDate { get; set; }Property Value
| Type |
|---|
| System.DateTime |
EditTime
Gets or sets edit time of the document.
Declaration
public TimeSpan EditTime { get; set; }Property Value
| Type |
|---|
| System.TimeSpan |
HiddenCount
Gets or sets hidden count of the document.
Declaration
public int HiddenCount { get; set; }Property Value
| Type |
|---|
| System.Int32 |
Item[ExcelBuiltInProperty]
Gets single entry from the collection. Read-only.
Declaration
public IDocumentProperty this[ExcelBuiltInProperty index] { get; }Parameters
| Type | Name | Description |
|---|---|---|
| ExcelBuiltInProperty | index |
Property Value
| Type |
|---|
| IDocumentProperty |
Item[Int32]
Gets single entry from the collection. Read-only.
Declaration
public IDocumentProperty this[int iIndex] { get; }Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | iIndex |
Property Value
| Type |
|---|
| IDocumentProperty |
Keywords
Gets or sets Keywords of the document.
Declaration
public string Keywords { get; set; }Property Value
| Type |
|---|
| System.String |
LastAuthor
Gets or sets last author of the document.
Declaration
public string LastAuthor { get; set; }Property Value
| Type |
|---|
| System.String |
LastPrinted
Gets or sets last printed of the document.
Declaration
public DateTime LastPrinted { get; set; }Property Value
| Type |
|---|
| System.DateTime |
LastSaveDate
Gets or sets last saved date of the document.
Declaration
public DateTime LastSaveDate { get; set; }Property Value
| Type |
|---|
| System.DateTime |
LineCount
Gets or sets line count of the document.
Declaration
public int LineCount { get; set; }Property Value
| Type |
|---|
| System.Int32 |
LinksDirty
Gets or sets boolean value to indicate whether the custom links are hampered by excessive noise, for all applications.
Declaration
public bool LinksDirty { get; set; }Property Value
| Type |
|---|
| System.Boolean |
Manager
Gets or sets Manager of the document.
Declaration
public string Manager { get; set; }Property Value
| Type |
|---|
| System.String |
MultimediaClipCount
Gets or sets Mutlimedia clip count of the document.
Declaration
public int MultimediaClipCount { get; set; }Property Value
| Type |
|---|
| System.Int32 |
NoteCount
Gets or sets note count of the document.
Declaration
public int NoteCount { get; set; }Property Value
| Type |
|---|
| System.Int32 |
PageCount
Gets or sets page count of the document.
Declaration
public int PageCount { get; set; }Property Value
| Type |
|---|
| System.Int32 |
ParagraphCount
Gets or sets paragraph count of the document.
Declaration
public int ParagraphCount { get; set; }Property Value
| Type |
|---|
| System.Int32 |
PresentationTarget
Target format for presentation (35mm, printer, video, and so on).
Declaration
public string PresentationTarget { get; set; }Property Value
| Type |
|---|
| System.String |
RevisionNumber
Gets or sets revision number of the document.
Declaration
public string RevisionNumber { get; set; }Property Value
| Type |
|---|
| System.String |
ScaleCrop
Set to True when scaling of the thumbnail is desired. If not set, cropping is desired.
Declaration
public bool ScaleCrop { get; set; }Property Value
| Type |
|---|
| System.Boolean |
Security
Gets or sets security of the document.
Declaration
public int Security { get; set; }Property Value
| Type |
|---|
| System.Int32 |
SlideCount
Gets or sets slide count of the document.
Declaration
public int SlideCount { get; set; }Property Value
| Type |
|---|
| System.Int32 |
Subject
Gets or sets subject of the document.
Declaration
public string Subject { get; set; }Property Value
| Type |
|---|
| System.String |
Template
Gets or sets template of the document.
Declaration
public string Template { get; set; }Property Value
| Type |
|---|
| System.String |
Title
Gets or sets title of the document.
Declaration
public string Title { get; set; }Property Value
| Type |
|---|
| System.String |
WordCount
Gets or sets word count of the document.
Declaration
public int WordCount { get; set; }Property Value
| Type |
|---|
| System.Int32 |
Methods
Contains(ExcelBuiltInProperty)
Indicates whether collection contains specified property.
Declaration
public bool Contains(ExcelBuiltInProperty index)Parameters
| Type | Name | Description |
|---|---|---|
| ExcelBuiltInProperty | index | Property id. |
Returns
| Type | Description |
|---|---|
| System.Boolean | True if collection contains required property. |
OnClearComplete()
OnClear is invoked after Clear behavior.
Declaration
protected override void OnClearComplete()Overrides
OnInsertComplete(Int32, DocumentPropertyImpl)
OnInsert is invoked after Insert behavior.
Declaration
protected override void OnInsertComplete(int index, DocumentPropertyImpl value)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | index | Index to be inserted. |
| DocumentPropertyImpl | value | Value to be inserted. |
Overrides
Parse(DocumentPropertyCollection)
Extract built-in document properties.
Declaration
public void Parse(DocumentPropertyCollection properties)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentPropertyCollection | properties |
|
ReadProperties(PropertySection, IDictionary, List<DocumentPropertyImpl>, Boolean, Boolean)
Reads properties from PropertySection.
Declaration
public static void ReadProperties(PropertySection section, IDictionary dicProperties, List<DocumentPropertyImpl> lstProperties, bool bSummary, bool bBuiltIn)Parameters
| Type | Name | Description |
|---|---|---|
| PropertySection | section | PropertySection to read data from. |
| System.Collections.IDictionary | dicProperties | Dictionary that will receive new properties. |
| System.Collections.Generic.List<DocumentPropertyImpl> | lstProperties | List to add properties to. |
| System.Boolean | bSummary | Indicates whether we are reading document summary properties. |
| System.Boolean | bBuiltIn | Indicates whether property is built-in. |
Serialize(PropertySection, PropertySection)
Serializes built-in properties with summary and document.
Declaration
public void Serialize(PropertySection summarySection, PropertySection documentSection)Parameters
| Type | Name | Description |
|---|---|---|
| PropertySection | summarySection | Summary section to be serialized. |
| PropertySection | documentSection | Document section to be serialized. |
WriteProperties(PropertySection, ICollection)
Writes properties into specified property section with values.
Declaration
public static void WriteProperties(PropertySection section, ICollection values)Parameters
| Type | Name | Description |
|---|---|---|
| PropertySection | section | Property sections to be written. |
| System.Collections.ICollection | values | Values to be written. |