C# Class Nexus.Client.Settings.GeneralSettingsGroup

The group of general settings.
Inheritance: SettingsGroup
显示文件 Open project: NexusMods/NexusModManager-4.5 Class Usage Examples

Public Methods

Method Description
AddFileAssociation ( string p_strExtension, string p_strDescription ) : void

Add a possible client programme file association.

GeneralSettingsGroup ( IEnvironmentInfo p_eifEnvironmentInfo ) : System

A simple constructor that initializes the object with the given dependencies.

Load ( ) : void

Loads the grouped setting values from the persistent store.

Save ( ) : bool

Persists the grouped setting values to the persistent store.

Protected Methods

Method Description
AssociateFile ( FileAssociationSetting p_fasFileAssociation ) : void

Associates the specifed file type with the client.

AssociateUrl ( string p_strUrlProtocol, string p_strDescription ) : void

Associates the specifed URL protocol with the client.

IsAssociated ( string p_strExtension ) : bool

Determines if the specified file type is associated with the client.

IsUrlAssociated ( string p_strUrlProtocol ) : bool

Determines if the specified URL protocol is associated with the client.

UnassociateFile ( FileAssociationSetting p_fasFileAssociation ) : void

Removes the association of the specifed file type with the client.

UnassociateUrl ( string p_strUrlProtocol ) : void

Removes the association of the specifed URL protocol with the client.

Private Methods

Method Description
AddShellExtension ( string p_strExtension ) : void

Adds a shell extension for the file type represented by the specified key.

RemoveShellExtension ( string p_strExtension ) : void

Removes a shell extension for the file type represented by the specified key.

Method Details

AddFileAssociation() public method

Add a possible client programme file association.
public AddFileAssociation ( string p_strExtension, string p_strDescription ) : void
p_strExtension string The extension to allow to be associated with the client.
p_strDescription string A description of the file type.
return void

AssociateFile() protected method

Associates the specifed file type with the client.
Thrown if the user does not have sufficient priviledges /// to create the association.
protected AssociateFile ( FileAssociationSetting p_fasFileAssociation ) : void
p_fasFileAssociation FileAssociationSetting The description of the file type association to create.
return void

AssociateUrl() protected method

Associates the specifed URL protocol with the client.
Thrown if the user does not have sufficient priviledges /// to create the association.
protected AssociateUrl ( string p_strUrlProtocol, string p_strDescription ) : void
p_strUrlProtocol string The URL protocol for which to create an association.
p_strDescription string The description of the URL protocol.
return void

GeneralSettingsGroup() public method

A simple constructor that initializes the object with the given dependencies.
public GeneralSettingsGroup ( IEnvironmentInfo p_eifEnvironmentInfo ) : System
p_eifEnvironmentInfo IEnvironmentInfo The application's envrionment info.
return System

IsAssociated() protected method

Determines if the specified file type is associated with the client.
protected IsAssociated ( string p_strExtension ) : bool
p_strExtension string The extension of the file type for which it is to be determined /// whether it is associated with the client.
return bool

IsUrlAssociated() protected method

Determines if the specified URL protocol is associated with the client.
protected IsUrlAssociated ( string p_strUrlProtocol ) : bool
p_strUrlProtocol string The protocol of the URL for which it is to be determined /// whether it is associated with the client.
return bool

Load() public method

Loads the grouped setting values from the persistent store.
public Load ( ) : void
return void

Save() public method

Persists the grouped setting values to the persistent store.
public Save ( ) : bool
return bool

UnassociateFile() protected method

Removes the association of the specifed file type with the client.
Thrown if the user does not have sufficient priviledges /// to remove the association.
protected UnassociateFile ( FileAssociationSetting p_fasFileAssociation ) : void
p_fasFileAssociation FileAssociationSetting The description of the file type association to remove.
return void

UnassociateUrl() protected method

Removes the association of the specifed URL protocol with the client.
Thrown if the user does not have sufficient priviledges /// to remove the association.
protected UnassociateUrl ( string p_strUrlProtocol ) : void
p_strUrlProtocol string The URL protocol for which to remove the association.
return void