RenamingRuleIndex Property
The index of the current renaming rule.
Syntax
edifacttranslator.getRenamingRuleIndex([callback]) edifacttranslator.setRenamingRuleIndex( renamingRuleIndex, [callback])
Default Value
-1
Callback
The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).
The callback for the getRenamingRuleIndex([callback]) method is defined as:
function(err, data){ }
'err' is the error that occurred. If there was no error, then 'err' is 'null'.
'data' is the value returned by the method.
The callback for the setRenamingRuleIndex([callback]) method is defined as:
function(err){ }
'err' is the error that occurred. If there was no error, then 'err' is 'null'.
'err' has 2 properties which hold detailed information:
err.code err.message
Remarks
This property specifies the current renaming rule. Valid values are from 0 to RenamingRuleCount - 1.
When set RenamingRule is populated with the renaming rule identified by the index.
This property is not available at design time.
Data Type
Integer