ScriptUI (SUI)

A global class containing central information about ScriptUI. Not instantiable.

Methods:

getResourceText, newImage, newFont

Property Listing

Name

Type

Access

Description

Alignment

String

readonly

Collects the enumerated values that can be used in the alignment and alignChildren properties of controls and containers.

Predefined alignment values are: TOP, BOTTOM, LEFT, RIGHT, FILL, CENTER

FontStyle

Object

readonly

Collects the enumerated values that can be used as the style argument to the ScriptUI.newFont() method.

Predefined styles are REGULAR, BOLD, ITALIC, BOLDITALIC.

applicationFonts

Object

readonly

The font constants defined by the host application.

compatibility

Object

readonly

An object whose properties are the names of compatability modes supported by the host application.

The presence of ScriptUI.compatability.su1PanelCoordinates means that the application allows backward compatibility with the coordinate system of Panel elements in ScriptUI version 1.

coreVersion

String

readonly

A string containing the internal version number of the ScriptUI module.

environment

Environment (SUI)

readonly

An object whose properties define attributes of the environment in which ScriptUI operates.

events

Events (SUI)

readonly

An object whose properties and methods provide access to objects used in the ScriptUI event system.

It contains one function, createEvent(), which allows you to create event objects in order to simulate user-interaction event

frameworkName

String

readonly

A string containing the name of the UI component framework with which this version of ScriptUI is compatible.

version

VariesSUI

readonly

A string containing the version number of the ScriptUI component framework

Method Listing

String getResourceText (text:String)

Finds and returns the resource for a given text string from the host application's resource data.

If no string resource matches the given text, the text itself is returned.

Parameter

Type

Description

text

String

The text to match.

ScriptUIFont (SUI) newFont (name:String, style:String Number, size:Number)

Creates a new font object for use in text controls and titles.

Parameter

Type

Description

name

String

The font name, or the font family name.

style

String

Number

The font style; can be string, or one of the values of ScriptUI.FontStyle.

size

Number

The font size in points.

ScriptUIImage (SUI) newImage (normal:String, [disabled:String], [pressed:String], [rollover:String])

Loads a new image from resources or disk files into an image object.

Creates a new global image object for use in controls that can display images, loading the associated images from the specified resources or image files.

Parameter

Type

Description

normal

String

The resource name or the disk file path to the image used for the normal state.

disabled

String

The resource name, or the disk file path to the image used for the disabled state.

pressed

String

The resource name, or the file-system path to the image used for the pressed state.

rollover

String

The resource name, or the file-system path to the image used for the rollover state.