SftMaskAutoComplete.File Property	Softel vdm, Inc.

Defines the file used to store autocomplete entries.

Syntax       

	Get
		VB.NET	String = object.File  As String
		VB	String = object.File  As String
		C#.NET	string String = object.File;
		VC++	_bstr_t String = object->File; _bstr_t String = object->GetFile();
		C	HRESULT object->get_File(BSTR* String);
		Delphi	String := object.File_   : WideString;
	Put
		VB.NET	object.File = String  As String
		VB	object.File = String  As String
		C#.NET	string object.File = String;
		VC++	_bstr_t object->File = String; void object->PutFile(_bstr_t String);
		C	HRESULT object->put_File(BSTR String);
		Delphi	object.File_ := String   : WideString;

object

A SftMaskAutoComplete object.

String

A string defining the filename where autocomplete entries are stored, a full path or a partial path with leading "-" character (see below). To disable the autocomplete feature specify an empty or null string.

Comments

The File property defines the file used to store autocomplete entries.

This property is required when the AutoComplete.Contents property is set to contentsSftMaskText. If the File property is assigned an empty or null string, the autocomplete feature is not available.

If the AutoComplete.Contents property is set to contentsSftMaskFiles, contentsSftMaskDirs or contentsSftMaskFilesDirs, the File property can be assigned an empty or null string, as file/directory lists or selections are never saved. If the File property is specified, the height and width of the autocomplete window is saved so it can be restored later.

Each Masked Edit control should use a unique file name to store autocomplete entries.

Saved autocomplete entries are stored in the file defined by the File property. The String argument should specify a full path, not just a file name.

If the String argument starts with a "-" character, the remainder (excluding the "-" character) is appended to the system defined application data folder. This folder is generally named "Documents and Settings\username\Application Data", which is usually a hidden folder. This folder name can be obtained using the Windows API SHGetFolderPath CSIDL_APPDATA.

The File property can define a full path (explicitly or by using the "-" character). Any subdirectories that are specified are automatically created if they do not exist.

When using the leading "-" character, it is recommended to use an initial subdirectory name, uniquely identifying the application or the company name, in order to avoid any accidental naming conflict.