Set a file to an item reference.

Namespace:  Aras.IOM
Assembly:  IOM (in IOM.dll) Version: 11.0.0.6296

Syntax

C#
public Item setFileProperty(
	string propertyName,
	string pathToFile
)
Visual Basic (Declaration)
Public Function setFileProperty ( _
	propertyName As String, _
	pathToFile As String _
) As Item
J#
public Item setFileProperty(
	String propertyName,
	String pathToFile
)
JScript
public function setFileProperty(
	propertyName : String, 
	pathToFile : String
) : Item

Parameters

propertyName
Type: System..::.String
name of property of type File for which new physical file should be set
pathToFile
Type: System..::.String
path to physical file which should be attached to property of the item

Return Value

Item of type File generated by method

Remarks

This method will allow to add/update a value of property with data type Item and data source File. Internally it will be created an item "File" with action "add" and set this new item to the property with name "propertyName". When Apply method would be called on the container item, new file will uploaded to the user's default vault server.

Exceptions

ExceptionCondition
System..::.ArgumentNullException
  • Agrument "propertyName" is null or empty.
  • Agrument "pathToFile" is null or empty.

See Also