SolidFramework.SolidEnvironment Class Reference

Represents Solid environment functionality More...

Static Public Member Functions
static string	GetAppDataDirectory ()
static bool	SetAppDataDirectory (string path)
static bool	SetTempFileIsAboutToBeCreated (Func< string, bool > callback)
	Creates a callback to allow monitoring of temporary file creation. This is intended to support anti-virus software that monitors file creation. More...
static string	GetSolidTempDirectory ()
static NativeError	GetUniqueMachineID (ref Byte[] id)
	Gets the unique machine ID as a byte array. Consider using License.GetUniqueMachineID instead. More...
static String	PlatformPath (String path)
	Construct platform defined path. More...
static String	GetSupportedFileFilters (bool includeAll)
	Gets the supported file filters. More...
static String	GetSupportedFileFilters (bool includeAll, String excludeList)
	Gets the supported file filters. More...

Properties
static IMacroEngine	IMacroEngine [getset]
static String	Build [get]
	Gets the build number.
static String	Version [get]
	Gets the version number.
static bool	Nucleus [getset]
	Gets or sets a value indicating whether this SolidEnvironment is nucleus. More...
static System.Drawing.Bitmap	IdentityBitmap [getset]
	Gets or sets the identity bitmap. More...
static string	MachineID [get]
	Gets the machine ID.
static Boolean	IsWindows [get]
	Gets a value indicating whether the environment is windows. More...
static string	Windows [get]
static Boolean	IsUnix [get]
	Gets a value indicating whether the environment is unix. More...
static Boolean	IsLinux [get]
	Gets a value indicating whether the environment is Linux. More...
static Boolean	IsARM [get]
static Boolean	IsOSX [get]
	Gets a value indicating whether the environment is OSX. More...
static String	OpenSourceLicenses [get]
static FileVersionInfo	Word10toWord12Version \"/" [get]
	Gets the word10 to word12 version.
static FileVersionInfo	Word11toWord12Version [get]
	Gets the word11 to word12 version.
static FileVersionInfo	WordVersion [get]
	Gets the Word version.
static FileVersionInfo	ExcelVersion [get]
	Gets the Excel version.
static FileVersionInfo	PowerPointVersion [get]
	Gets the PowerPoint version.
static FileVersionInfo	PublisherVersion [get]
	Gets the publisher version.
static FileVersionInfo	CreatorVersion [get]
	Gets the Solid PDF Creator version.
static FileVersionInfo	ToolsVersion [get]
	Gets the Solid PDF Tools version.
static String	OfficePDFCreationFor2007 [get]
	Gets the office PDF creation for2007. More...
static Dictionary< String, String >	SupportedFileTypes [get]
	Gets the supported file types. More...
static String	Acrobat [get]
	Gets the Adobe Acrobat version.
static String	AcrobatPlugin [get]
	Gets the Acrobat Plug-in version.
static String	AcrobatSolid [get]
	Gets the Solid Acrobat Plug-in version.
static String	AcrobatPath [get]
	Gets the Adobe Acrobat path.
static String??	Excel [get]
	Gets the Excel version.
static String??	PowerPoint [get]
	Gets the PowerPoint version.
static String??	Word [get]
	Gets the word version.
static String??	Publisher [get]
	Gets the Publisher version.
static string	Creator [get]
	Gets Solid Pdf Creator version.
static string	Tools [get]
	Gets Solid PDF Tools version.

Detailed Description

Represents Solid environment functionality

Member Function Documentation

GetSupportedFileFilters() [1/2]

static String SolidFramework.SolidEnvironment.GetSupportedFileFilters ( bool  includeAll )

static

Gets the supported file filters.

Parameters

includeAll

if set to true [include all].

Returns

GetSupportedFileFilters() [2/2]

static String SolidFramework.SolidEnvironment.GetSupportedFileFilters ( bool  includeAll, String  excludeList  )

static

Gets the supported file filters.

Parameters

includeAll	if set to true [include all].
excludeList	The exclude list.

Returns

GetUniqueMachineID()

static NativeError SolidFramework.SolidEnvironment.GetUniqueMachineID ( ref Byte[]  id )

static

Gets the unique machine ID as a byte array. Consider using License.GetUniqueMachineID instead.

Parameters

id	The byte array to store the id in.

Returns

NativeError.Success or NativeError.Fail if the machine id contained multi-byte characters

PlatformPath()

static String SolidFramework.SolidEnvironment.PlatformPath ( String  path )

static

Construct platform defined path.

Parameters

path

The path.

Returns

SetTempFileIsAboutToBeCreated()

static bool SolidFramework.SolidEnvironment.SetTempFileIsAboutToBeCreated ( Func< string, bool >  callback )

static

Creates a callback to allow monitoring of temporary file creation. This is intended to support anti-virus software that monitors file creation.

Parameters

callback

When handling the callback, return true to allow the file to be created, or false to prevent creation. Note that preventing temp file creation will probably prevent Solid Framework from being able to proceed.

Returns

Example:

SolidEnvironment.SetTempFileIsAboutToBeCreated(path => { Console.WriteLine(path); return true; });

Property Documentation

IdentityBitmap

System.Drawing.Bitmap SolidFramework.SolidEnvironment.IdentityBitmap

staticgetset

Gets or sets the identity bitmap.

The identity bitmap.

IsLinux

Boolean SolidFramework.SolidEnvironment.IsLinux

staticget

Gets a value indicating whether the environment is Linux.

true if this instance is Linux; otherwise, false.

IsOSX

Boolean SolidFramework.SolidEnvironment.IsOSX

staticget

Gets a value indicating whether the environment is OSX.

true if this instance is OSX; otherwise, false.

IsUnix

Boolean SolidFramework.SolidEnvironment.IsUnix

staticget

Gets a value indicating whether the environment is unix.

true if this instance is unix; otherwise, false.

IsWindows

Boolean SolidFramework.SolidEnvironment.IsWindows

staticget

Gets a value indicating whether the environment is windows.

true if this instance is windows; otherwise, false.

Nucleus

bool SolidFramework.SolidEnvironment.Nucleus

staticgetset

Gets or sets a value indicating whether this SolidEnvironment is nucleus.

true if nucleus; otherwise, false.

OfficePDFCreationFor2007

String SolidFramework.SolidEnvironment.OfficePDFCreationFor2007

staticget

Gets the office PDF creation for2007.

The office PDF creation for2007.

SupportedFileTypes

Dictionary<String,String> SolidFramework.SolidEnvironment.SupportedFileTypes

staticget

Gets the supported file types.

The supported file types.