MfEnvironment

Namespace ›› System ››
Parent Previous Next

MfEnvironment Class

(Inherits from MfResourceSingletonBase)

Contains Properties and Methods that are related to the current Environment including access to built in resources via GetResourceString() and GetResourceStringBySection().

This class is a singleton and is accessed via the MfEnvironment.Instance property.

Links

Properties, Methods, Remarks

Constructors


Name

Description

Constructor()

Constructor new instance of MfEnvironment class

Properties


Name

Description

CommonAppData

Gets the Common App Data Folder

CommonDesktop

Gets the Common Desktop Folder

CommonDocuments

Gets the Common Documents Folder

CommonMusic

Gets the Common Music Folder

CommonPictures

Gets the Common Pictures Folder

CommonStartMenu

Gets the Common Start Menu Folder

CommonStartup

Gets the Common Startup Folder

CommonVideo

Gets the Common Video Folder

Instance

Gets a Singleton instance of derived class. Inherited from MfSingletonBase

NewLine

Gets var string of the new line chars for the current environment.

ResourceFolder

Gets the current resource folder for Mini-Framework as var string.

TickCount

Gets the number of milliseconds elapsed since the system started

UserAppDataLocal

Gets the current users Local App Data Folder

UserAppDataRoaming

Gets the current users Roaming App Data Folder

UserDesktop

Gets the current users Desktop Folder

UserDocuments

Gets the current users Document Folder

UserFavorites

Gets the current users Favorites Folder

UserMusic

Gets the current users Music Folder

UserPictures

Gets the current users Picture Folder

UserStartMenu

Gets the current users Start Menu Folder

UserStartup

Gets the current users Startup Folder

UserVideo

Gets the current users Video Folder

Methods


Name

Description

CompareTo()

Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object. Inherited from MfObject.

DestroyInstance()

Set current instance of singleton derived class to null. Overrides MfSingletonBase.DestroyInstance()

Equals(obj)

Compares obj to current instance to see if they are the same. Inherited from MfObject.

GetHashCode()

Gets A hash code for the current MfObject. Inherited from MfObject.

GetInstance()

Gets the instance of the Singleton. Overrides MfSingletonBase.GetInstance()

GetResourceString(key)

Gets a resource string from the current resource file for the given key. Overrides MfResourceSingletonBase.GetResourceString()

GetResourceString(key, args*)

Gets a resource string from the current resource file for the given key and formats the resource string with the args*. Overrides MfResourceSingletonBase.GetResourceString()

GetResourceStringBySection(Key, section)

Gets a resource string from the current resource file for the specified section and key. Overrides MfResourceSingletonBase.GetResourceStringBySection()

GetResourceStringBySection(Key, section, args*)

Gets a resource string from the current resource file for the specified section and key.
The resource string is formated by the args*. Overrides MfResourceSingletonBase.GetResourceStringBySection()

GetType()

Gets the Type for the for the Class .Inherited from MfObject.

Is(type)

Gets if current instance of object is of the same type. Inherited from MfObject. Inherited from MfObject.

IsInstance()

Get if the current class is an instance. Inherited from MfObject.

MemberwiseClone()

Creates a shallow copy of the current MfObject instance. Inherited from MfObject.

Reset()

Resets the current Environment Instance so the the next call it is loaded again

ToString()

Gets a string representation of the MfObject. Inherited from MfObject.

Remarks

Sealed Class