Environment

Overview

Environment helper class.

Location

  • Reference:
    • Elements.dll  .NET, .NET Standard 2.0
    • elements.jar  Cooper
    • Elements.fx  Island, ToffeeV2
    • libElements.fx  Toffee
  • Namespace: RemObjects.Elements.RTL

Properties


ApplicationContext

Application context in an Android application. The application should set this before doing anything that requires the context to be set.

 

class property ApplicationContext: ApplicationContext read write;

 

class ApplicationContext ApplicationContext { get; set; }

 

static var ApplicationContext: ApplicationContext { get{} set{} }

 

class ApplicationContext ApplicationContext { __get; __set; }

CurrentDirectory

Returns the directory that's currently active for this process.

 

class property CurrentDirectory: String read;

 

class String CurrentDirectory { get; }

 

static var CurrentDirectory: String { get{} }

 

class String CurrentDirectory { __get; }

DesktopFolder

Returns the path to the desktop folder

 

class property DesktopFolder: nullable Folder read;

 

class Folder? DesktopFolder { get; }

 

// .NET, .NET Standard 2.0, Island, ToffeeV2
static var DesktopFolder: Folder? { get{} }
// Toffee
static var DesktopFolder: Folder { get{} }

 

class Folder DesktopFolder { __get; }

EnvironmentVariable

Access an environment variable by name.

 

class property EnvironmentVariable[Name: String]: String read write;

 

class String EnvironmentVariable[String Name] { get; set; }

 

static subscript EnvironmentVariable(_ Name: String) -> String { get{} set{} }

 

class String EnvironmentVariable[String Name] { __get; __set; }

FullUserName

Returns the full name of the current user.

 

class property FullUserName: String read;

 

class String FullUserName { get; }

 

static var FullUserName: String { get{} }

 

class String FullUserName { __get; }

IsMono

True if running on Mono

 

class property IsMono: Boolean read;

 

class Boolean IsMono { get; }

 

static var IsMono: Boolean { get{} }

 

class Boolean IsMono { __get; }

LineBreak

Gets the linebreak character for this OS. Generally #13#10 on Windows and #10 elswhere.

 

class property LineBreak: String read;

 

class String LineBreak { get; }

 

static var LineBreak: String { get{} }

 

class String LineBreak { __get; }

MachineName

Returns the name of this machine.

 

class property MachineName: String read;

 

class String MachineName { get; }

 

static var MachineName: String { get{} }

 

class String MachineName { __get; }

OS

Gets the OS type. Use this to determine what the current OS type is.

 

class property OS: OperatingSystem read;

 

class OperatingSystem OS { get; }

 

static var OS: OperatingSystem { get{} }

 

class OperatingSystem OS { __get; }

OSBitness

Returns the bitsize of this OS. Generally 32 or 64.

 

class property OSBitness: Int32 read;

 

class Int32 OSBitness { get; }

 

static var OSBitness: Int32 { get{} }

 

class Integer OSBitness { __get; }

OSName

Returns a string representation of this OS name.

 

class property OSName: String read;

 

class String OSName { get; }

 

static var OSName: String { get{} }

 

class String OSName { __get; }

OSVersion

Returns the string version.

 

class property OSVersion: String read;

 

class String OSVersion { get; }

 

static var OSVersion: String { get{} }

 

class String OSVersion { __get; }

ProcessBitness

Returns the bitsize of this process. Generally 32 or 64.

 

class property ProcessBitness: Int32 read;

 

class Int32 ProcessBitness { get; }

 

static var ProcessBitness: Int32 { get{} }

 

class Integer ProcessBitness { __get; }

SystemApplicationSupportFolder

Returns the application support folder for shared files.

 

class property SystemApplicationSupportFolder: nullable Folder read;

 

class Folder? SystemApplicationSupportFolder { get; }

 

// .NET, .NET Standard 2.0, Island, ToffeeV2
static var SystemApplicationSupportFolder: Folder? { get{} }
// Toffee
static var SystemApplicationSupportFolder: Folder { get{} }

 

class Folder SystemApplicationSupportFolder { __get; }

TempFolder

Returns the temporary path

 

class property TempFolder: nullable Folder read;

 

class Folder? TempFolder { get; }

 

// .NET, .NET Standard 2.0, Island, ToffeeV2
static var TempFolder: Folder? { get{} }
// Toffee
static var TempFolder: Folder { get{} }

 

class Folder TempFolder { __get; }

UserApplicationSupportFolder

Returns the application support folder for user files.

 

class property UserApplicationSupportFolder: nullable Folder read;

 

class Folder? UserApplicationSupportFolder { get; }

 

// .NET, .NET Standard 2.0, Island, ToffeeV2
static var UserApplicationSupportFolder: Folder? { get{} }
// Toffee
static var UserApplicationSupportFolder: Folder { get{} }

 

class Folder UserApplicationSupportFolder { __get; }

UserDownloadsFolder

Returns the downloads folder.

 

class property UserDownloadsFolder: nullable Folder read;

 

class Folder? UserDownloadsFolder { get; }

 

// .NET, .NET Standard 2.0, Island, ToffeeV2
static var UserDownloadsFolder: Folder? { get{} }
// Toffee
static var UserDownloadsFolder: Folder { get{} }

 

class Folder UserDownloadsFolder { __get; }

UserHomeFolder

Returns the home folder.

 

class property UserHomeFolder: nullable Folder read;

 

class Folder? UserHomeFolder { get; }

 

// .NET, .NET Standard 2.0, Island, ToffeeV2
static var UserHomeFolder: Folder? { get{} }
// Toffee
static var UserHomeFolder: Folder { get{} }

 

class Folder UserHomeFolder { __get; }

UserLibraryFolder

Returns the library or appdata folder.

 

class property UserLibraryFolder: nullable Folder read;

 

class Folder? UserLibraryFolder { get; }

 

// .NET, .NET Standard 2.0, Island, ToffeeV2
static var UserLibraryFolder: Folder? { get{} }
// Toffee
static var UserLibraryFolder: Folder { get{} }

 

class Folder UserLibraryFolder { __get; }

UserName

Returns the current username.

 

class property UserName: String read;

 

class String UserName { get; }

 

static var UserName: String { get{} }

 

class String UserName { __get; }