psSkinFile - cCJSkinFramework

Determines the name of skin file

Type: Property

Access: Read/Write

Data Type: String

Parameters: None

Syntax
 Property String psSkinFile

Read Access: Get psSkinFile to StringVariable
Write Access: Set psSkinFile to StringVariable/Value


Description

psSkinFile determines the name of the skin file. This will be a file with a .cjstyles or .msstyles extension. It is used along with psSkinIni to determine which skin will be applied to your application.

The default for psSkinFIle is "". If the value of psSkinFile is empty or invalid, no skin is applied.

Typically the psSkinFile name will be a relative name and it will be located relative to the default skin directory, which is your workspace's Programs directory. psSkinFile may also be fully qualified.

When psSkinFile and psSkinIni are defined within the skin object, the skin will be applied as the object is created. This is typically how the skin object is used.

Object oSkin is a cCJSkinFramework
    Set psSkinFile to "WinXP.Luna.cjstyles"
    Set psSkinIni  to "NormalHomeStead.ini"
End_Object

If skins are applied dynamically, you must set your skin properties and then call ApplySkin.

Procedure SetANewSkin String sFile String sIni
    Set psSkinFile of ghoSkinFramework to sFile
    Set psSkinIni  of ghoSkinFramework to sIni
    Send ApplySkin of ghoSkinFramework
End_procedure

If the psSkinIni is blank, the first skin section in the skin file is applied.

The default location for skins is the workspace's programs directory. This location is determined by calling SkinPath, which can be augmented to return a different skin path.

A list of all available skins and skin sections can be obtained by calling the EnumerateSkins method.

ghoSkinFramework is a global handle to your skin object. This can be used to access the skin object from within other objects.

See Also

psSkinIni | pbLoadPreference