Login    Sites MenuBlueStep

BlueStep Platform Support

RelateScript
Outline full outline 
Overview 
Data Types 
Operators 
Statements 
Functions 
Working with Relate Data 
Field Data 
Text Fields 
Memo Fields 
Date/Time Fields 
Number Fields 
Boolean Fields 
Single Select Fields 
Multiple Select Fields 
Signature Fields 
Document Fields 
clear(...) 
getContent(...) 
getDefaultPath(...) 
getThumbnailHTML(...) 
getThumbnailURL(...) 
import(...) 
move(...) 
rename(...) 
setContent(...) 
setContentFromURL(...) 
setContentType(...) 
setNotes(...) 
setVersioned(...) 
Image Transformations 
Document Permissions 
Relationship Fields 
Biometric Fields 
Password Fields 
Accessing Forms and Fields 
Special Data and Functions 
How Formulas Work 
Related Topics 

The rename(...) function has only one variation, not counting syntax variations.  The function simply changes the name of the currently referenced document.  The result of the rename(...) function is a boolean value indicating if the rename was successful.

Syntax:
rename( document-fieldname )
document-field.rename( name )

Parameter Description
document-field The document field referencing the document which will be renamed.  If the field is read-only in the formula it will return false. If it does not currently reference a document the function will return null.
name The new name of the document.  If name is null or the empty-string, or if a document or folder already exists in that location with that name, then the rename will not occur and the function will return false.  The new name of the document can contain any characters except the forward slash, "/".  However, remember that Microsoft operating systems also do not support several other characters; specifically, the following characters are not allowed: < > : " / \ | ? *