Class actuate.reportexplorer.FileCondition
Description
Used in actuate.reportexplorer.FileSearch objects for comparison. Contains a display field associated with a filter string called a match. This can be used for the purposes of comparing field values for searching, filtering, or batch operations. For example, a file condition can match the FileType field with rptdesign to identify all the rptdesign files for a filter.
Constructor
Syntax
actuate.reportexplorer.FileCondition( )
Constructs a new FileCondition object.
Function summary
Table 7‑47 lists actuate.reportexplorer.FileCondition functions.
Table 7‑47 actuate.reportexplorer.FileCondition functions
Function
Description
getField( )
Gets the field for this FileCondition
getMatch( )
Gets the match value for this FileCondition
setField( )
Sets the field for this FileCondition
setMatch( )
Sets the match value for this FileCondition
getField
Syntax
string FileCondition.getField( )
Returns the field for this FileCondition.
Returns
String. Possible values are "Name", "FileType", "Description", "PageCount", "Size", "TimeStamp", "Version", "VersionName", and "Owner".
Example
To store the display field of fcondition in a variable called field, use code similar to the following:
var field = fcondition.getField( );
getMatch
Syntax
string FileCondition.getMatch( )
Returns the match value for this FileCondition.
Returns
String. A string for comparison.
Example
To store the matching condition of fcondition in a variable called match, use code similar to the following:
var match = fcondition.getMatch( );
setField
Syntax
void FileCondition.setField(string field)
Sets the field for the FileCondition.
Parameter
field
String. Possible values are "Name", "FileType", "Description", "PageCount", "Size", "TimeStamp", "Version", "VersionName", and "Owner".
Example
To set the display field to FileType for fcondition, use code similar to the following:
fcondition.setField("FileType");
setMatch
Syntax
void FileCondition.setMatch(string match)
Sets the match value for the FileCondition.
Parameter
match
String. A string for comparison.
Example
To set the match value for fcondition to rptdesign, use code similar to the following:
fcondition.setField("rptdesign");