XlsDocumentProperty module
- class XlsDocumentProperty.XlsDocumentProperty
Bases:
IDocumentPropertyRepresents a document property in an Excel workbook.
This class provides properties and methods for accessing and manipulating document properties (metadata) in Excel workbooks, such as title, author, creation date, etc. It implements the IDocumentProperty interface.
- property Boolean: bool
Gets or sets the value of the document property as a boolean.
- Returns:
The boolean value of the document property.
- Return type:
bool
- Clone() SpireObject
Creates a clone of this document property.
- Returns:
A new instance of the document property with the same values.
- Return type:
SpireObject
- static DEF_FILE_TIME_START_YEAR() int
Gets the default file time start year constant.
- Returns:
The default file time start year (typically 1601).
- Return type:
int
- property DateTime: DateTime
Gets or sets the value of the document property as a date and time.
- Returns:
The date and time value of the document property.
- Return type:
DateTime
- property Double: float
Gets or sets the value of the document property as a double-precision floating-point number.
- Returns:
The double-precision floating-point value of the document property.
- Return type:
float
- FillPropVariant(variant: IPropertyData, iPropertyId: int) bool
Fills a property variant with the document property data.
- Parameters:
variant (IPropertyData) – The property data object to fill.
iPropertyId (int) – The ID of the property.
- Returns:
True if the operation was successful; otherwise, False.
- Return type:
bool
- property Int32: int
Gets or sets the value of the document property as a 32-bit integer.
- Returns:
The 32-bit integer value of the document property.
- Return type:
int
- property Integer: int
Gets or sets the value of the document property as an integer.
- Returns:
The integer value of the document property.
- Return type:
int
- property InternalName: str
Gets the internal name of the document property.
- Returns:
The internal name of the document property.
- Return type:
str
- property IsBuiltIn: bool
Gets whether the property is a built-in document property.
- Returns:
True if the property is built-in; otherwise, False.
- Return type:
bool
- property LinkSource: str
Gets or sets the source of the linked document property.
- Returns:
The source of the linked document property.
- Return type:
str
- property LinkToContent: bool
Gets or sets whether the document property is linked to content.
- Returns:
True if the property is linked to content; otherwise, False.
- Return type:
bool
- property Name: str
Gets the name of the document property.
- Returns:
The name of the document property.
- Return type:
str
- property ObjectArray: List[SpireObject]
Gets or sets the value of the document property as an array of objects.
- Returns:
The object array value of the document property.
- Return type:
List[SpireObject]
- property PropertyId: BuiltInPropertyType
Gets or sets the ID of the built-in property.
- Returns:
An enumeration value representing the built-in property type.
- Return type:
BuiltInPropertyType
- property PropertyType: PropertyType
Gets or sets the type of the document property.
- Returns:
An enumeration value representing the property type.
- Return type:
PropertyType
- SetLinkSource(variant: IPropertyData)
Sets the link source for the document property using property data.
- Parameters:
variant (IPropertyData) – The property data containing the link source.
- property StringArray: List[str]
Gets or sets the value of the document property as an array of strings.
- Returns:
The string array value of the document property.
- Return type:
List[str]
- property Text: str
Gets or sets the value of the document property as text.
- Returns:
The text value of the document property.
- Return type:
str
- property TimeSpan: TimeSpan
Gets or sets the value of the document property as a time span.
- Returns:
The time span value of the document property.
- Return type:
TimeSpan
- property Value: SpireObject
Gets or sets the value of the document property as a generic object.
- Returns:
The value of the document property.
- Return type:
SpireObject