Filename Property (FormDefinitionFile)

Visual Basic
C#
C++/CLI

'Declaration
 
Public Property Filename As String

'Usage
 
Dim instance As FormDefinitionFile
Dim value As String
 
instance.Filename = value
 
value = instance.Filename

public string Filename {get; set;}

public:
property String^ Filename {
   String^ get();
   void set (    String^ value);
}

You should make sure this property is set to the filename of the form definition file before you call the Read, Write, or Lock methods. The file must exist before you call the Read method. However, if the file does not exist, but the folder that contains it does exist, the Lock method will automatically create the file.

You can set this property to either a relative or absolute filename. If you use a relative filename, it must be relative to the form set that contains the form definition file. This object will use that parent to determine the location of the form set file.

Normally, the FormSetFile.CreateNewForm or FormSet.Read methods will set this property. You will only need to set this property if you are not using those methods.

If you set this property to an invalid filename, this object will not detect and notify you of that error until you try to lock or read from the file.

Valid value: any valid relative or absolute filename, including files which contain characters outside the English character set.

Default value: ""

Reference

FormDefinitionFile Class
FormDefinitionFile Members
Read Method
Write Method
Lock Method
FormSetFile.CreateNewForm Method
FullPath Property