Class BuiltinDocumentProperties

Represents the built-in document properties of Word document.

Inheritance
System.Object
OwnerHolder
XDLSSerializableBase
SummaryDocumentProperties
BuiltinDocumentProperties
Implements
Inherited Members
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()
Namespace: Syncfusion.DocIO.DLS
Assembly: Syncfusion.DocIO.Base.dll
Syntax
public class BuiltinDocumentProperties : SummaryDocumentProperties, IXDLSSerializable
Remarks

The following list contains the names of all the available built-in document properties:

Examples

The following code example demonstrates how to modify the built-in document properties of Word document.

private void Button1_Click(System.Object sender, System.EventArgs e)
{
    //Load an existing Word document into DocIO instance
    WordDocument document = new WordDocument("Template.docx", FormatType.Docx);
    //Set the value for Company property of the document
    document.BuiltinDocumentProperties.Company = "Northwind Traders";
    //Set the value for Manager property of the document
    document.BuiltinDocumentProperties.Manager = "Paul Anderson";
    //Set the value for Author property of the document
    document.BuiltinDocumentProperties.Author = "Peter";
    //Set the value for Comments property of the document
    document.BuiltinDocumentProperties.Comments = "This document provide the sales information of the year 2015";
    //Set the value for LastAuthor property of the document
    document.BuiltinDocumentProperties.LastAuthor = "Johnson";
    //Set the value for Title property of the document
    document.BuiltinDocumentProperties.Title = "Sales Information";
    //Set the value for Category property of the document
    document.BuiltinDocumentProperties.Category = "Sales";
    document.Save("Result.docx", FormatType.Docx);
    document.Close();
}
Private Sub button_Click(sender As Object, e As EventArgs)
    'Load an existing Word document into DocIO instance
    Dim document As New WordDocument("Template.docx", FormatType.Docx)
    'Set the value for Company property of the document
    document.BuiltinDocumentProperties.Company = "Northwind Traders"
    'Set the value for Manager property of the document
    document.BuiltinDocumentProperties.Manager = "Paul Anderson"
    'Set the value for Author property of the document
    document.BuiltinDocumentProperties.Author = "Peter"
    'Set the value for Comments property of the document
    document.BuiltinDocumentProperties.Comments = "This document provide the sales information of the year 2015"
    'Set the value for LastAuthor property of the document
    document.BuiltinDocumentProperties.LastAuthor = "Johnson"
    'Set the value for Title property of the document
    document.BuiltinDocumentProperties.Title = "Sales Information"
    'Set the value for Category property of the document
    document.BuiltinDocumentProperties.Category = "Sales"
    document.Save("Result.docx", FormatType.Docx)
    document.Close()
End Sub

Properties

BytesCount

Gets the number of bytes in the document.

Declaration
public int BytesCount { get; }
Property Value
Type Description
System.Int32

The integer that represents the number of bytes.

Category

Gets or sets the category of the document.

Declaration
public string Category { get; set; }
Property Value
Type Description
System.String

The string that represents the document category.

Company

Gets or sets Company property in the document.

Declaration
public string Company { get; set; }
Property Value
Type Description
System.String

The string that specifies the company property.

HiddenCount

Gets hidden count in the document.

Declaration
public int HiddenCount { get; }
Property Value
Type Description
System.Int32

The integer that specifies the hidden count in the document.

LinesCount

Gets the number of lines in the document.

Declaration
public int LinesCount { get; }
Property Value
Type Description
System.Int32

The integer that represents the lines count in the document.

Manager

Gets or sets Manager property in the document.

Declaration
public string Manager { get; set; }
Property Value
Type Description
System.String

The string that specifies the manager property.

NoteCount

Gets Note count in the document.

Declaration
public int NoteCount { get; }
Property Value
Type Description
System.Int32

The integer that specifies the note count in the document.

ParagraphCount

Gets the number of paragraphs in the document.

Declaration
public int ParagraphCount { get; }
Property Value
Type Description
System.Int32

The integer that represents the paragraphs count in the document.

SlideCount

Gets slide count in the document.

Declaration
public int SlideCount { get; }
Property Value
Type Description
System.Int32

The integer that specifies the slide count in the document.

Methods

Clone()

Creates a duplicate copy of the current built-in properties.

Declaration
public BuiltinDocumentProperties Clone()
Returns
Type Description
BuiltinDocumentProperties

The new BuiltinDocumentProperties that is created.

ReadXmlAttributes(IXDLSAttributeReader)

Reads object data from xml attributes.

Declaration
protected override void ReadXmlAttributes(IXDLSAttributeReader reader)
Parameters
Type Name Description
IXDLSAttributeReader reader

The IXDLSAttributeReader object.
Overrides

WriteXmlAttributes(IXDLSAttributeWriter)

Writes object data as xml attributes.

Declaration
protected override void WriteXmlAttributes(IXDLSAttributeWriter writer)
Parameters
Type Name Description
IXDLSAttributeWriter writer

The IXDLSAttributeWriter object.
Overrides

Implements

See Also