The FX interface

The FX interface is a special interface designed for working with asset files. Some of its properties and methods duplicate functionality available in other interfaces. The FX object is accessed through the Application interface.

FX properties

FXmethods

FX properties

The FX interface supports one property, Path.

Path 
Access  Read-only 
Type  String 
Description  Returns the path to the assets. Application.AssetsPath returns the same information. 
Usage 
JScript  Application.FX.Path;  
VBScript  Application.FX.Path 

FX methods

The FX interface supports the following methods:

CopyFile(strSource,strDest,[boolForceUpdate=false]) 
Returns  Boolean 
Description  Copies the file strSource to strDest. strSource can be a filename or URL. If boolForceUpdate is true, the file will be copied even if strDest already exists (provided that it is writable). See also Application.CopyAssetFile. Returns true if the copy succeeds. 
Usage 
JScript  Application.FX.CopyFile(strSource, strDest, [boolForceUpdate]);  
VBScript  Application.FX.CopyFile(strSource, strDest, [boolForceUpdate]) 

DTC(strGUID) 
Returns  No return value 
Description  Launches the Design-Time Control specified by strGUID at the drop-point. 
Usage 
JScript  Application.FX.DTC(strGUID);  
VBScript  Application.FX.DTC strGUID 

HTML([strMarkup],[strSrcfile],[strTargetElem],[strID],[strLocation],[boolSelect]) 
Returns  No return value 
Description  Paste the string strMarkup or the file strSrcFile in the document that the asset is dropped on. Paste in strTargetElem if specified. Do not paste if the ID strID is present in the document. Paste at the strLocation (START or END) of strTargetElem. If boolSelect is set to true, select the inserted content after it has been inserted. See also Selection.InsertElement and Selection.PasteString
Usage 
JScript  Application.FX.HTML([strMarkup], [strSrcfile], [strTargetElem], [strID], [strLocation], [boolSelect]);  
VBScript  Application.FX.HTML [strMarkup], [strSrcfile], [strTargetElem], [strID], [strLocation], [boolSelect] 
Example 
// SoftQuad Script Language JSCRIPT: 
// [other code] 
Application.FX.HTML("<IMG SRC="face.gif">);
 

RemoveAll(strElemName) 
Returns  No return value 
Description  Remove all instances of element strElemName (and their contents) from the document. 
Usage 
JScript  Application.FX.RemoveAll(strElemName);  
VBScript  Application.FX.RemoveAll strElemName 
Example 
// SoftQuad Script Language JSCRIPT: 
Application.FX.RemoveAll("IMG"); 
 

SelectDropPoint 
Returns  No return value 
Description  If the current script was run by being dragged-and-dropped or pasted into a document, SelectDropPoint makes the point at which the script was dropped the current selection. See also Application.DropPoint
Usage 
JScript  Application.FX.SelectDropPoint;  
VBScript  Application.FX.SelectDropPoint 

SetAttribute(strElemName, strAttrName, strAttrValue, strRelative) 
Returns  No return value 
Description  Set the strAttrName of the strElemName element to strAttrValue. If strRelative is set to `Parent', the operation is applied to a parent element of the drop point; if it is set to `First', the operation is applied to the first instance of strElemName in the document. See also Selection.ContainerAttribute
Usage 
JScript  Application.FX.SetAttribute(strElemName, strAttrName, strAttrValue, strRelative);  
VBScript  Application.FX.SetAttribute strElemName, strAttrName, strAttrValue, strRelative 
Example 
// SoftQuad Script Language JSCRIPT: 
Application.FX.SetAttribute("H1","ALIGN","LEFT","First");
 

ShowDialog(strDialogName) 
Returns  No return value 
Description  Displays the HoTMetaL PRO dialog specified by strDialogName. Allowed values are:
  • ANCHOR: The Insert Link dialog
  • ACTIVEX: The ActiveX Controls dialog
  • APPLET: The Choose Applet dialog
The selection must be inside the appropriate element (A, OBJECT, or APPLET) in order for the dialog box to be displayed. See also Selection.InsertLink
Usage 
JScript  Application.FX.ShowDialog(strDialogName);  
VBScript  Application.FX.ShowDialog strDialogName 
Example 
//SoftQuad Script Language JSCRIPT: 
Application.FX.ShowDialog("ANCHOR");
 

Surround(strText1,strText2,[boolSelected=false]) 
Returns  No return value 
Description  Inserts strText1 before the selection and strText2 after the selection. strText1 and strText2 can be any text, including start- and end-tags. If boolSelected is true, the selection remains selected after the operation has completed. See also Selection.Surround
Usage 
JScript  Application.FX.Surround(strText1,strText2,[boolSelected=false]);  
VBScript  Application.FX.Surround strText1,strText2,[boolSelected=false] 
Example 
//SoftQuad Script Language JSCRIPT: 
Application.FX.Surround("<P>","</P>");
 


Right arrow
Next Topic
Left arrow
Previous Topic
Table of contents
Table of Contents

Copyright © SoftQuad Software Inc. 1999