Example:
//Instantiate a Workbook object
$workbook = new cells\Workbook("Book1.xls");
//Retrieve a list of all custom document properties of the Excel file
$customProperties = $workbook->getWorksheets()->getCustomDocumentProperties();
//Accessng a custom document property by using the property index
$customProperty1 = $customProperties->get(0);
//Accessng a custom document property by using the property name
$customProperty2 = $customProperties->get("Owner");
| Property Getters/Setters Summary | ||
|---|---|---|
function | isGeneratedName() | |
| Returns true if this property does not have a name in the OLE2 storage and a unique name was generated only for the public API. | ||
function | isLinkedToContent() | |
| Indicates whether this property is linked to content | ||
function | getName() | |
| Returns the name of the property. | ||
function | getSource() | |
| The linked content source. | ||
function | getType() | |
| Gets the data type of the property. The value of the property is PropertyType integer constant. | ||
function | getValue() | |
function | setValue(value) | |
| Gets or sets the value of the property. | ||
| Method Summary | ||
|---|---|---|
function | toBool() | |
| Returns the property value as bool. | ||
function | toDateTime() | |
| Returns the property value as DateTime in local timezone. | ||
function | toDouble() | |
| Returns the property value as double. | ||
function | toInt() | |
| Returns the property value as integer. | ||
function | toString() | |
| Returns the property value as a string. | ||
| Property Getters/Setters Detail |
|---|
getName : String | |
function getName() | |
getValue/setValue : Object | |
function getValue() / function setValue(value) | |
isLinkedToContent : boolean | |
function isLinkedToContent() | |
getSource : String | |
function getSource() | |
getType : Number | |
function getType() | |
isGeneratedName : boolean | |
function isGeneratedName() | |
| Method Detail |
|---|
toString | |
function toString() | |
Converts a number property using Object.ToString(). Converts a boolean property into "Y" or "N". Converts a date property into a short date string.
toInt | |
function toInt() | |
toDouble | |
function toDouble() | |
toDateTime | |
function toDateTime() | |
Throws an exception if the property type is not PropertyType.Date.
toBool | |
function toBool() | |
Throws an exception if the property type is not PropertyType.Boolean.