OpenTAP 9.27
API Reference
Public Types | Public Member Functions | Properties | List of all members
OpenTap.FilePathAttribute Class Reference

Identifies a string as a file path. More...

Inheritance diagram for OpenTap.FilePathAttribute:
OpenTap.FileDependencyAttribute OpenTap.IAnnotation

Public Types

enum  BehaviorChoice { Open , Save }
 Describes how the file should be used on access. More...
 

Public Member Functions

 FilePathAttribute ()
 Constructor for the FilePathAttribute. More...
 
 FilePathAttribute (BehaviorChoice behavior=BehaviorChoice.Open, string fileExtension="")
 Constructor that takes BehaviourChoice and fileExtension parameters for the FilePathAttribute. More...
 

Properties

string FileExtension [get]
 Default file extension for this file path.
 
bool OverwritePrompt [get]
 Boolean setting. When true, raises a prompt for permission to overwrite the file if it already exists. If false, no prompt is raised and the file is overwritten.
 
BehaviorChoice Behavior [get]
 The behavior of the file path dialog associated with this file path.
 

Detailed Description

Identifies a string as a file path.

Member Enumeration Documentation

◆ BehaviorChoice

Describes how the file should be used on access.

Enumerator
Open 

Opens the file.

Save 

Saves the file. Provides a warning if file already exists.

Constructor & Destructor Documentation

◆ FilePathAttribute() [1/2]

OpenTap.FilePathAttribute.FilePathAttribute ( )
inline

Constructor for the FilePathAttribute.

Provided for backward compatibility.

◆ FilePathAttribute() [2/2]

OpenTap.FilePathAttribute.FilePathAttribute ( BehaviorChoice  behavior = BehaviorChoice.Open,
string  fileExtension = "" 
)
inline

Constructor that takes BehaviourChoice and fileExtension parameters for the FilePathAttribute.

Parameters
behavior
fileExtensionFile extension or filter. Simple file extensions can be used like this: txt, csv, .... Or a filter extression can be used, for example "Text Document (*.txt) | *.txt. See examples for more info."

OpenTAP 9.27 API built Wed Nov 27 2024 13:14:45