AttachmentOperations ^(8.1)

Operations related to Dodeca Attachments.

Overloads

Overload Name	Description
AttachFile	Attaches the specified file.
AttachFileShortcut	Creates a shortcut to the specified file and attaches the shortcut. This would typically be a file on a network drive.
AttachUrlShortcut	Creates a shortcut to the specified Url and attaches the shortcut.
Delete	Deletes one or more attachments. AttachmentID or KeyItems must be specified. If AttachmentID is specified one attachment may be deleted. KeyItems will be ignored. If KeyItems is specified more than one attachments may be deleted depending on the number of items that are attached to the intersection specified by the KeyItems. If Name is specified with KeyItems then all attachments at the intersection specified by the KeyItems having the specified name will be deleted.
Export	Exports one or more attachments. AttachmentID or KeyItems must be specified. If AttachmentID is specified one attachment may be exported. KeyItems will be ignored. If KeyItems is specified more than one attachments may be exported depending on the number of items that are attached to the intersection specified by the KeyItems. If Name is specified with KeyItems then all attachments at the intersection specified by the KeyItems having the specified name will be exported.
Open	Opens one attachments. AttachmentID or KeyItems must be specified. If AttachmentID is specified one attachment may be opened. KeyItems will be ignored. If KeyItems is specified the first attachment that is attached to the intersection specified by the KeyItems will be opened. If Name is specified with KeyItems the first attachment that is attached to the intersection specified by the KeyItems and has the specified name will be opened.

AttachFile

Attaches the specified file.

Argument	Description
SpecifySheetBy	Select how to specify which worksheet to select while the method is being executed. Specify one of the following values or an arbitrary value: `<blank>SheetNameSheetNumberAllSheets`
SheetSpec	Specify the sheet-name or sheet-number, depending on SpecifySheetBy. If SpecifySheetBy is AllSheets then SheetSpec can be left empty.
Address	The address of a range to select for the execution of the method.
CellByCell	Whether to execute the method on a cell-by-cell basis, or on the range specified by the address.
ReverseOrder	Whether to loop through the rows and columns from highest to lowest. Only applies when CellByCell is true.
MethodCondition	If the result of method-condition expression resolves to FALSE, then the method is not executed. Specify one of the following values or an arbitrary value: `<blank>FALSETRUE`
CellCondition	If the result of the condition expression resolves to FALSE, then the current cell is skipped. Specify one of the following values or an arbitrary value: `<blank>FALSETRUE`
Filename	The name of the file to attach.
Folder	The path to the folder that contains the specified file.
Description	The description of the new attachment.
IncrementName	Whether to add a subscript, such as (2), to the name of the attachment if the comment being attached to already has an attachment with the same name. If blank TRUE will be used. If FALSE attachments with the same name will be overwritten. Specify one of the following values or an arbitrary value: `<blank>FALSETRUE`
KeyItems	A semicolon delimited list of key-value pairs such as "Year=Jan;Market=East;Scenario=Budget". Each key item must be expressed as =, where neither nor are blank. The @KeyItems( ) function can be used to specify the KeyItems of a specific cell. If KeyItems is blank the KeyItems of the active cell (if any) will be used.
AllowedFileTypes	A semicolon delimited string of file types. ex: ".xlsx;.txt;.docx". Only attachments of the file types specified will be allowed to be attached. If not specified then all types are allowed except for restricted types.
MaximumFileSize	The maximum allowed file size of attachments in KB. If left blank the MaximumFileSize property of the associated CommentRange will be used.
MaximumAttachments	The maximum number of files that can be attached to a comment. If left blank the MaximumAttachments property of the associated CommentRange will be used.
UseDialog	Whether to use a file dialog to specify the file. If left blank FALSE will be used. Specify one of the following values or an arbitrary value: `<blank>FALSETRUE`
DialogTitle	A caption to use at the title of the file dialog.
DialogResultPropertyName	If specified a script property with the specified name will be created with result of the file dialog. The @PVal() function can be used to get the value.
IdPropertyName	If specified a script property with the specified name will be created with the exported attachmentId. The @PVal() function can be used to get the value.
FullFilePathPropertyName	If specified a script property with the specified name will be created with full path of the attached file. The @PVal() function can be used to get the value.

AttachFileShortcut

Creates a shortcut to the specified file and attaches the shortcut. This would typically be a file on a network drive.

Argument	Description
SpecifySheetBy	Select how to specify which worksheet to select while the method is being executed. Specify one of the following values or an arbitrary value: `<blank>SheetNameSheetNumberAllSheets`
SheetSpec	Specify the sheet-name or sheet-number, depending on SpecifySheetBy. If SpecifySheetBy is AllSheets then SheetSpec can be left empty.
Address	The address of a range to select for the execution of the method.
CellByCell	Whether to execute the method on a cell-by-cell basis, or on the range specified by the address.
ReverseOrder	Whether to loop through the rows and columns from highest to lowest. Only applies when CellByCell is true.
MethodCondition	If the result of method-condition expression resolves to FALSE, then the method is not executed. Specify one of the following values or an arbitrary value: `<blank>FALSETRUE`
CellCondition	If the result of the condition expression resolves to FALSE, then the current cell is skipped. Specify one of the following values or an arbitrary value: `<blank>FALSETRUE`
Filename	The name of the file to attach.
Folder	The path to the folder that contains the specified file.
Description	The description of the new attachment.
IncrementName	Whether to add a subscript, such as (2), to the name of the attachment if the comment being attached to already has an attachment with the same name. If blank TRUE will be used. If FALSE attachments with the same name will be overwritten. Specify one of the following values or an arbitrary value: `<blank>FALSETRUE`
KeyItems	A semicolon delimited list of key-value pairs such as "Year=Jan;Market=East;Scenario=Budget". Each key item must be expressed as =, where neither nor are blank. The @KeyItems( ) function can be used to specify the KeyItems of a specific cell. If KeyItems is blank the KeyItems of the active cell (if any) will be used.
AllowedFileTypes	A semicolon delimited string of file types. ex: ".xlsx;.txt;.docx". Only attachments of the file types specified will be allowed to be attached. If not specified then all types are allowed except for restricted types.
MaximumAttachments	The maximum number of files that can be attached to a comment. If left blank the MaximumAttachments property of the associated CommentRange will be used.
UseDialog	Whether to use a file dialog to specify the file. If left blank FALSE will be used. Specify one of the following values or an arbitrary value: `<blank>FALSETRUE`
DialogTitle	A caption to use at the title of the file dialog.
DialogResultPropertyName	If specified a script property with the specified name will be created with result of the file dialog. The @PVal() function can be used to get the value.
IdPropertyName	If specified a script property with the specified name will be created with the exported attachmentId. The @PVal() function can be used to get the value.
FullFilePathPropertyName	If specified a script property with the specified name will be created with full path of the attached file. The @PVal() function can be used to get the value.

AttachUrlShortcut

Creates a shortcut to the specified Url and attaches the shortcut.

Argument	Description
SpecifySheetBy	Select how to specify which worksheet to select while the method is being executed. Specify one of the following values or an arbitrary value: `<blank>SheetNameSheetNumberAllSheets`
SheetSpec	Specify the sheet-name or sheet-number, depending on SpecifySheetBy. If SpecifySheetBy is AllSheets then SheetSpec can be left empty.
Address	The address of a range to select for the execution of the method.
CellByCell	Whether to execute the method on a cell-by-cell basis, or on the range specified by the address.
ReverseOrder	Whether to loop through the rows and columns from highest to lowest. Only applies when CellByCell is true.
MethodCondition	If the result of method-condition expression resolves to FALSE, then the method is not executed. Specify one of the following values or an arbitrary value: `<blank>FALSETRUE`
CellCondition	If the result of the condition expression resolves to FALSE, then the current cell is skipped. Specify one of the following values or an arbitrary value: `<blank>FALSETRUE`
URL	The URL to create the shortcut for.
Name	The name of the attachment.
Description	The description of the new attachment.
IncrementName	Whether to add a subscript, such as (2), to the name of the attachment if the comment being attached to already has an attachment with the same name. If blank TRUE will be used. If FALSE attachments with the same name will be overwritten. Specify one of the following values or an arbitrary value: `<blank>FALSETRUE`
KeyItems	A semicolon delimited list of key-value pairs such as "Year=Jan;Market=East;Scenario=Budget". Each key item must be expressed as =, where neither nor are blank. The @KeyItems( ) function can be used to specify the KeyItems of a specific cell. If KeyItems is blank the KeyItems of the active cell (if any) will be used.
MaximumAttachments	The maximum number of files that can be attached to a comment. If left blank the MaximumAttachments property of the associated CommentRange will be used.
UseDialog	Whether to use a file dialog to specify the file. If left blank FALSE will be used. Specify one of the following values or an arbitrary value: `<blank>FALSETRUE`
DialogTitle	A caption to use at the title of the file dialog.
DialogResultPropertyName	If specified a script property with the specified name will be created with result of the file dialog. The @PVal() function can be used to get the value.
UrlPropertyName	If specified a script property with the specified name will be created with a value of the new attachment's URL. The @PVal() function can be used to get the value.
NamePropertyName	If specified a script property with the specified name will be created with a value of the name of the attachment that was opened. The @PVal() function can be used to get the value.
DescriptionPropertyName	If specified a script property with the specified name will be created with a value of the new attachment's Description. The @PVal() function can be used to get the value.
IdPropertyName	If specified a script property with the specified name will be created with the exported attachmentId. The @PVal() function can be used to get the value.

Delete

Deletes one or more attachments. AttachmentID or KeyItems must be specified.
If AttachmentID is specified one attachment may be deleted. KeyItems will be ignored.
If KeyItems is specified more than one attachments may be deleted depending on the number of items that are attached to the intersection specified by the KeyItems.
If Name is specified with KeyItems then all attachments at the intersection specified by the KeyItems having the specified name will be deleted.

Argument	Description
SpecifySheetBy	Select how to specify which worksheet to select while the method is being executed. Specify one of the following values or an arbitrary value: `<blank>SheetNameSheetNumberAllSheets`
SheetSpec	Specify the sheet-name or sheet-number, depending on SpecifySheetBy. If SpecifySheetBy is AllSheets then SheetSpec can be left empty.
Address	The address of a range to select for the execution of the method.
CellByCell	Whether to execute the method on a cell-by-cell basis, or on the range specified by the address.
ReverseOrder	Whether to loop through the rows and columns from highest to lowest. Only applies when CellByCell is true.
MethodCondition	If the result of method-condition expression resolves to FALSE, then the method is not executed. Specify one of the following values or an arbitrary value: `<blank>FALSETRUE`
CellCondition	If the result of the condition expression resolves to FALSE, then the current cell is skipped. Specify one of the following values or an arbitrary value: `<blank>FALSETRUE`
AttachmentID	The AttachmentID.
Name	The name of the attachment.
KeyItems	A semicolon delimited list of key-value pairs such as "Year=Jan;Market=East;Scenario=Budget". Each key item must be expressed as =, where neither nor are blank. The @KeyItems( ) function can be used to specify the KeyItems of a specific cell. If KeyItems is blank the KeyItems of the active cell (if any) will be used.
CountPropertyName	If specified a script property with the specified name will be created with count of the exported attachments. The @PVal() function can be used to get the value.
IdListPropertyName	If specified a script property with the specified name will be created with a semicolon delimited list of the effected attachment IDs.

Export

Exports one or more attachments. AttachmentID or KeyItems must be specified.
If AttachmentID is specified one attachment may be exported. KeyItems will be ignored.
If KeyItems is specified more than one attachments may be exported depending on the number of items that are attached to the intersection specified by the KeyItems.
If Name is specified with KeyItems then all attachments at the intersection specified by the KeyItems having the specified name will be exported.

Argument	Description
SpecifySheetBy	Select how to specify which worksheet to select while the method is being executed. Specify one of the following values or an arbitrary value: `<blank>SheetNameSheetNumberAllSheets`
SheetSpec	Specify the sheet-name or sheet-number, depending on SpecifySheetBy. If SpecifySheetBy is AllSheets then SheetSpec can be left empty.
Address	The address of a range to select for the execution of the method.
CellByCell	Whether to execute the method on a cell-by-cell basis, or on the range specified by the address.
ReverseOrder	Whether to loop through the rows and columns from highest to lowest. Only applies when CellByCell is true.
MethodCondition	If the result of method-condition expression resolves to FALSE, then the method is not executed. Specify one of the following values or an arbitrary value: `<blank>FALSETRUE`
CellCondition	If the result of the condition expression resolves to FALSE, then the current cell is skipped. Specify one of the following values or an arbitrary value: `<blank>FALSETRUE`
AttachmentID	The AttachmentID.
Name	The name of the attachment.
KeyItems	A semicolon delimited list of key-value pairs such as "Year=Jan;Market=East;Scenario=Budget". Each key item must be expressed as =, where neither nor are blank. The @KeyItems( ) function can be used to specify the KeyItems of a specific cell. If KeyItems is blank the KeyItems of the active cell (if any) will be used.
Folder	The path to the folder that contains the specified file.
FileExistsPolicy	Determines what to do if there is an existing file with the same name. If not specified Increment will be used. Increment = Add a sequence number to the file name like "FileName(1).txt". Overwrite = Overwrite the existing file. PromptForName = Prompt the user for a unique name. PromptForOverwrite = Prompt the user for whether to overwrite the file. SkipSilent = Do not export. SkipWithMessage = Prompt user with message that file was not exported. Specify one of the following values or an arbitrary value: `IncrementOverwritePromptForNamePromptForOverwriteSkipSilentSkipWithMessage`
UseDialog	Whether to use a file dialog to specify the file. If left blank FALSE will be used. Specify one of the following values or an arbitrary value: `<blank>FALSETRUE`
DialogTitle	A caption to use at the title of the file dialog.
DialogResultPropertyName	If specified a script property with the specified name will be created with result of the file dialog. The @PVal() function can be used to get the value.
CountPropertyName	If specified a script property with the specified name will be created with count of the exported attachments. The @PVal() function can be used to get the value.
FolderPropertyName	If specified a script property with the specified name will be created with the path of the output folder.
FilePathsListPropertyName	If specified a script property with the specified name will be created with a semicolon delimited list of the full paths of each exported file. The @PVal() function can be used to get the value.
IdListPropertyName	If specified a script property with the specified name will be created with a semicolon delimited list of the effected attachment IDs.
NamesListPropertyName	If specified a script property with the specified name will be created with a semicolon delimited list of the exported attachment names. The @PVal() function can be used to get the value.

Open

Opens one attachments. AttachmentID or KeyItems must be specified.
If AttachmentID is specified one attachment may be opened. KeyItems will be ignored.
If KeyItems is specified the first attachment that is attached to the intersection specified by the KeyItems will be opened.
If Name is specified with KeyItems the first attachment that is attached to the intersection specified by the KeyItems and has the specified name will be opened.

Argument	Description
SpecifySheetBy	Select how to specify which worksheet to select while the method is being executed. Specify one of the following values or an arbitrary value: `<blank>SheetNameSheetNumberAllSheets`
SheetSpec	Specify the sheet-name or sheet-number, depending on SpecifySheetBy. If SpecifySheetBy is AllSheets then SheetSpec can be left empty.
Address	The address of a range to select for the execution of the method.
CellByCell	Whether to execute the method on a cell-by-cell basis, or on the range specified by the address.
ReverseOrder	Whether to loop through the rows and columns from highest to lowest. Only applies when CellByCell is true.
MethodCondition	If the result of method-condition expression resolves to FALSE, then the method is not executed. Specify one of the following values or an arbitrary value: `<blank>FALSETRUE`
CellCondition	If the result of the condition expression resolves to FALSE, then the current cell is skipped. Specify one of the following values or an arbitrary value: `<blank>FALSETRUE`
AttachmentID	The AttachmentID.
Name	The name of the attachment.
KeyItems	A semicolon delimited list of key-value pairs such as "Year=Jan;Market=East;Scenario=Budget". Each key item must be expressed as =, where neither nor are blank. The @KeyItems( ) function can be used to specify the KeyItems of a specific cell. If KeyItems is blank the KeyItems of the active cell (if any) will be used.
Folder	The path to the folder that contains the specified file.
FileExistsPolicy	Determines what to do if there is an existing file with the same name. If not specified Increment will be used. Increment = Add a sequence number to the file name like "FileName(1).txt". Overwrite = Overwrite the existing file. PromptForName = Prompt the user for a unique name. PromptForOverwrite = Prompt the user for whether to overwrite the file. SkipSilent = Do not export. SkipWithMessage = Prompt user with message that file was not exported. Specify one of the following values or an arbitrary value: `IncrementOverwritePromptForNamePromptForOverwriteSkipSilentSkipWithMessage`
UseDialog	Whether to use a file dialog to specify the file. If left blank FALSE will be used. Specify one of the following values or an arbitrary value: `<blank>FALSETRUE`
DialogTitle	A caption to use at the title of the file dialog.
DialogResultPropertyName	If specified a script property with the specified name will be created with result of the file dialog. The @PVal() function can be used to get the value.
FolderPropertyName	If specified a script property with the specified name will be created with the path of the output folder.
FullFilePathPropertyName	If specified a script property with the specified name will be created with full path of the attached file. The @PVal() function can be used to get the value.
NamePropertyName	If specified a script property with the specified name will be created with a value of the name of the attachment that was opened. The @PVal() function can be used to get the value.
IdPropertyName	If specified a script property with the specified name will be created with the exported attachmentId. The @PVal() function can be used to get the value.

AttachmentOperations (8.1)