User Guide Cancel

SpreadsheetAddInfo

 

Note:

You can find the CFFiddle demo of this function and other spreadsheet functions as part of a project that is shared with you.

Click the button below to launch CFFiddle.

To copy the project in your workspace in CFFiddle, follow the steps below:

  1. Log in with your Gmail or Facebook credentials.
  2. Navigate to the project in the left pane.
  3. Once you make some changes in any cfm in the project, a pop up displays asking you to save the project.
  4. Give the project a suitable name and click Save.

Description

Sets document properties for a new spreadsheet or modifies properties for an existing spreadsheet.

Returns

Nothing

Category

Syntax

SpreadsheetAddInfo(spreadsheetobj, property_struct)
SpreadsheetAddInfo(spreadsheetobj, property_struct)
SpreadsheetAddInfo(spreadsheetobj, property_struct)

See also

History

ColdFusion 9: Added the function.

Parameters

Parameter

Description

spreadsheetobj

The Excel spreadsheet object from which to get the value.

property_struct

The following properties of the spreadsheet can be modified or set:

  • AUTHOR
  • CATEGORY
  • LASTAUTHOR
  • COMMENTS
  • KEYWORDS
  • MANAGER
  • COMPANY
  • SUBJECT
  • TITLE

Example

This sample sets the following properties of the file myinfo.xlsx:

  • title
  • category
  • author
  • subject
<cfscript>
spreadsheetObj=SpreadSheetNew("Test sheet");
myInfo=StructNew();
myInfo.title="sample title";
myInfo.category="sample category";
myInfo.author="sample author";
myInfo.subject="sample subject";
SpreadSheetAddInfo(spreadsheetObj,myInfo);
myFile=GetDirectoryFromPath(GetCurrentTemplatePath()) & "myinfo.xlsx";
SpreadSheetWrite(spreadsheetObj,"#myFile#",true);
</cfscript>
<cfscript> spreadsheetObj=SpreadSheetNew("Test sheet"); myInfo=StructNew(); myInfo.title="sample title"; myInfo.category="sample category"; myInfo.author="sample author"; myInfo.subject="sample subject"; SpreadSheetAddInfo(spreadsheetObj,myInfo); myFile=GetDirectoryFromPath(GetCurrentTemplatePath()) & "myinfo.xlsx"; SpreadSheetWrite(spreadsheetObj,"#myFile#",true); </cfscript>
<cfscript>
       spreadsheetObj=SpreadSheetNew("Test sheet");
       myInfo=StructNew();
       myInfo.title="sample title";
       myInfo.category="sample category";
       myInfo.author="sample author";
       myInfo.subject="sample subject";
       SpreadSheetAddInfo(spreadsheetObj,myInfo);
       myFile=GetDirectoryFromPath(GetCurrentTemplatePath()) & "myinfo.xlsx";
       SpreadSheetWrite(spreadsheetObj,"#myFile#",true);
</cfscript>

Output

Spreadsheet information
Spreadsheet information

Get help faster and easier

New user?