NewFormFilenamePrefix Property

Visual Basic
C#
Managed Extensions for C++
C++/CLI

'Declaration
 
Public Property NewFormFilenamePrefix As String

'Usage
 
Dim instance As FormSetFile
Dim value As String
 
instance.NewFormFilenamePrefix = value
 
value = instance.NewFormFilenamePrefix

public string NewFormFilenamePrefix {get; set;}

public: __property string* get_NewFormFilenamePrefix();
public: __property void set_NewFormFilenamePrefix( 
   string* value
);

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

Whenever you call the CreateNewForm method, it will create a name for a new form definition file, based on this property and the NewFormFilenameSuffix property.

The new name will begin with the value of this property, followed by a 4 to 10 digit number, followed by the value of the NewFormFilenameSuffix property. CreateNewForm will pick a number that makes the filename unique. Note that this property may contain only a folder name (followed by "\"), only a filename prefix, or both.

The best value for this property depends on the method you want to use to name your form definition files. If you want all your form definition files to be in the same folder as the form set file (the default behavior), this property should not contain a folder name. You can set this property before you first call CreateNewForm and not change it again.

If you want all your form definition files to be in a subfolder of the folder that contains the form set file, you should set this property to the name of the subfolder. You can set this property before you first call CreateNewForm and not change it again.

If you want all your form definition files to be grouped in several subfolders of the folder that contains the form set file, you should set this property to the name of the appropriate subfolder just before you call CreateNewForm.

Regardless of how you arrange your form definition files in folders, you may also want to use a filename prefix. Without a filename prefix, your form definition files will be a sequence of digits, followed by an extension. The extension is sufficient to indicate that the files are form definition files, but you can add a prefix to the filename (in addition to the folder name) if you do not like numeric filenames.

In each of the cases above, you can set the folder name to a relative or absolute folder name. In most cases, a relative folder name is best since the files can be moved to a new location without causing the names to change. Of course, the form set file and all the form definition files have to be moved together and any subfolder relationships have to be maintained.

Valid value: Any string that will become a valid relative or absolute filename when CreateNewForm adds a number and the value of the NewFormFilenameSuffix property to it.

Default value: "form"

Reference

FormSetFile Class
FormSetFile Members
NewFormFilenameSuffix Property
CreateNewForm Method