How to set file properties for Excel file in Python
EasyXLS Excel library can be used to export Excel files with Python on Windows, Linux, Mac or other operating systems. The integration vary depending on the operating system or if the bridge for .NET Framework of Java is chosen:
To download the trial version of EasyXLS Excel Library, press the below button:
If you already own a license key, you may login and download EasyXLS from your account.
Install the downloaded EasyXLS installer for v8.6 or earlier.
Step 2: License file setup
Step required for EasyXLS v9.0 or later.
If you are using a trial, generate a trial license file from EasyXLS trials page. The trial license is valid for 30-days.
If you own a license key, you may login to the account that purchased the license and generate the license file from: https://www.easyxls.com/my-orders
Setup the license file into your project using these guidelines.
Step 3: Install Pythonnet
For the installation you need to run "pip" command as it follows. Pip is a package-management system used to install and manage software packages written in Python. <Python installation path>\Scripts>pip install "pythonnet.whl"
Step 4: Include EasyXLS library into project
EasyXLS.dll must be added to your project. EasyXLS.dll can be found: - Inside the downloaded archive at Step 1 for EasyXLS v9.0 or later - Under installation path for EasyXLS v8.6 or earlier, in "Dot NET version" folder.
Step 5: Run Python code that sets custom and details properties for Excel file
Execute the following Python code that sets the document properties of an Excel file, properties like subject, manager and a custom property.
"""-------------------------------------------------------------------------
Tutorial 33
This tutorial shows how to set document properties for Excel file in Python,
like 'Subject' property for summary information, 'Manager' property for
document summary information and a custom property.
-------------------------------------------------------------------------"""import clr
import gc
clr.AddReference('EasyXLS')
from EasyXLS import *
from EasyXLS.Constants import *
print("Tutorial 33\n-----------\n")
# Create an instance of the class that exports Excel files
workbook = ExcelDocument(1)
# Set the 'Subject' document property
workbook.getSummaryInformation().setSubject("This is the subject")
# Set the 'Manager' document property
workbook.getDocumentSummaryInformation().setManager("This is the manager")
# Set a custom document property
workbook.getDocumentSummaryInformation().setCustomProperty("PropertyName", FileProperty.VT_NUMBER, "4")
# Export Excel file
print("Writing file C:\\Samples\\Tutorial33 - Excel file properties.xlsx.")
workbook.easy_WriteXLSXFile("C:\\Samples\\Tutorial33 - Excel file properties.xlsx")
# Confirm export of Excel file
sError = workbook.easy_getError()
if sError == "":
print("\nFile successfully created.\n\n")
else:
print("\nError encountered: " + sError + "\n\n")
# Dispose memory
gc.collect()
EasyXLS on Linux, Mac, Windows using Java with Python
If you opt for the Java version of EasyXLS, a similar code as above requires Py4J, Pyjnius or any other bridge between Python and Java.
To download the trial version of EasyXLS Excel Library, press the below button:
If you already own a license key, you may login and download EasyXLS from your account.
Install the downloaded EasyXLS installer for v8.6 or earlier.
Step 2: License file setup
Step required for EasyXLS v9.0 or later.
If you are using a trial, generate a trial license file from EasyXLS trials page. The trial license is valid for 30-days.
If you own a license key, you may login to the account that purchased the license and generate the license file from: https://www.easyxls.com/my-orders
Setup the license file into your project using these guidelines.
Step 3: Install Py4j
For the Py4j installation you need to run "pip" command as it follows. Pip is a package-management system used to install and manage software packages written in Python. <Python installation path>\Scripts>pip install "py4j.whl"
Step 4: Create additional Java program
The following Java code needs to be running in the background prior to executing the Python code.
import py4j.GatewayServer;
publicclass GatewayServerApp {
publicstaticvoid main(String[] args) {
GatewayServerApp app = new GatewayServerApp();
// app is now the gateway.entry_point
GatewayServer server = new GatewayServer(app);
server.start();
}
}
Step 5: Add py4j library to CLASSPATH
py4j.jar must be added to your classpath of the additional Java program. py4j.jar can be found after installing Py4j, in "<Python installation path>\share\py4j" folder.
Step 6: Add EasyXLS library to CLASSPATH
EasyXLS.jar must be added to your classpath of the additional Java program. EasyXLS.jar can be found: - Inside the downloaded archive at Step 1 for EasyXLS v9.0 or later - Under installation path for EasyXLS v8.6 or earlier, in "Lib" folder.
Step 7: Run additional Java program
Start the gateway server application and it will implicitly start Java Virtual Machine as well.
Step 8: Run Python code that sets custom and details properties for Excel file
Execute a code as below Python code that sets the document properties of an Excel file, properties like subject, manager and a custom property.
"""-------------------------------------------------------------------------
Tutorial 33
This tutorial shows how to set document properties for Excel file in Python,
like 'Subject' property for summary information, 'Manager' property for
document summary information and a custom property.
-------------------------------------------------------------------------"""import gc
from py4j.java_gateway import JavaGateway
from py4j.java_gateway import java_import
gateway = JavaGateway()
java_import(gateway.jvm,'EasyXLS.*')
java_import(gateway.jvm,'EasyXLS.Constants.*')
print("Tutorial 33\n-----------\n")
# Create an instance of the class that exports Excel files
workbook = gateway.jvm.ExcelDocument(1)
# Set the 'Subject' document property
workbook.getSummaryInformation().setSubject("This is the subject")
# Set the 'Manager' document property
workbook.getDocumentSummaryInformation().setManager("This is the manager")
# Set a custom document property
workbook.getDocumentSummaryInformation().setCustomProperty("PropertyName",
gateway.jvm.FileProperty.VT_NUMBER, "4")
# Export Excel file
print("Writing file C:\\Samples\\Tutorial33 - Excel file properties.xlsx.")
workbook.easy_WriteXLSXFile("C:\\Samples\\Tutorial33 - Excel file properties.xlsx")
# Confirm export of Excel file
sError = workbook.easy_getError()
if sError == "":
print("\nFile successfully created.\n")
else:
print("\nError encountered: " + sError + "\n\n")
# Dispose memory
gc.collect()
