SftOptions 1.0

SftOptionsEntry.DefaultValue Property

Softel vdm, Inc.

Defines the entry's default value.

Syntax       

Get

VB.NET

String = object.DefaultValue  As String

VB

String = object.DefaultValue  As String

C#.NET

string String = object.DefaultValue;

VC++

_bstr_t String = object->DefaultValue;
_bstr_t String = object->GetDefaultValue();

C

HRESULT object->get_DefaultValue(BSTR* String);

Delphi

String := object.DefaultValue   : WideString;

Put

VB.NET

object.DefaultValue = String  As String

VB

object.DefaultValue = String  As String

C#.NET

string object.DefaultValue = String;

VC++

_bstr_t object->DefaultValue = String;
void object->PutDefaultValue(_bstr_t String);

C

HRESULT object->put_DefaultValue(BSTR String);

Delphi

object.DefaultValue := String   : WideString;

object

A SftOptionsEntry object.

String

Defines the entry's default value.

Comments

The DefaultValue property defines the entry's default value.  For possible values based on the entry type, please see the SftOptionsEntry.Value property.

The SftOptionsEntry.Restore and RestoreAll methods use the DefaultValue property to set the entry's Value property.

The DefaultValue property is used to initialize entries when no option information has been previously saved in the location defined by SftOptionsIO.File or SftOptionsIO.Registry 

When deploying an application, typically using a setup program, the Registry and INI files may need to be initialized.  The DefaultValue properties of the entries in a SftOptions control reflect the default values that would be set in response to the Restore or RestoreAll methods.  These default values are not automatically installed when deploying an application.  If the SftOptions control has not yet saved the property settings, the "SftOptions_Initialized" option has not yet been set to "1" (see SftOptions.Save).  This option could be tested by an installation program to initialize option settings in the Registry or INI file, possibly even using a SftOptions control.

See Also  SftOptionsEntry Object | Object Hierarchy


Feedback / comments / error reports for this topic
© 2002 - Softel vdm, Inc. - www.softelvdm.com