View object

Properties

view.eventsRoot = dlg;
while (dlg.isVisible) view.doEvent();
dlg.style#display = "none";
view.eventsRoot = null;

Methods

Method loads new document (replaces current one) in the current view from the given url. If now is equal to true this method loads document synchronously - method will return after document will be downloaded and loaded in the view.

Method loads new document (replaces current one) in the current view from the given in-memory stream.

Returns coordinates of the edges of the view. Parameters:

• part - one of symbolic constants #left, #top, #right, #bottom, #width or #height. Defines part of box (rectangle) to return.
• edge, one of view:
• #border - border box edge - OS window border bounds,
• #client - client area edge,
• relativeTo, one of:
• #screen - returns coordinate relative to the origin of the screen,
• #self, default value - all coordinates are relative to the origin of the client area of the view.

Replaces window of the view (dialog or frame) on the screen. This method is applicable only for standalone Sciter.

If clientCoordinates is true x and y are interpretted as a desired position of the client area on the screen.

Replaces window and changes dimension of the view (dialog or frame) on the screen. This method is applicable only for standalone Sciter.

If clientCoordinates is true x,y, width and height are interpretted as a desired position/size of the client area on the screen.

Methods shows system file selector modal dialog and returns full path name of the selected file or null if user cancels this dialog.

• First parameter is either #save or #load symbol. If #save is provided then dialog will have a caption Save As... otherwise (#load) it will have caption Open...
• filter is a string - filter which defines list of allowed file extensions seprated by character '|' in the form: "label1|file.ext1|label2|file.ext1|.." where label is a label of item (appears in the selector on the dialog) and file.ext is a ';' seprated list of filename templates.
• ext is a string - default file extension used if user will type filename without extension.

var fn = view.selectFile(#open,
         "HTML Files (*.htm,*.html)|*.HTM;*.HTML|All Files (*.*)|*.*" , "html" );
if( fn ) view.load(fn);

Shows modal dialog defined by document at url or contained in in-memory stream.  object parameters if given will be copied to view.parameters variable available for scripts inside dialog HTML.

position is an integer in range [1..9], it defines position of the dialog window relative to the parent view window. For meaning of the values see NUMPAD on the keyboard, e.g. position 5 means center/middle of the dialog will be placed in the center/middle of the view.

• type - symbol, one of the following values: #alert, #information, #question or #warning ;
• text - string, either plain text or html ;
• title - string, caption of the dialog window;
• buttons - button definition(s), either:
• one of the symbols: #ok, #cancel, #abort, #ignore, #yes, #no or #close, or
• object with the structure { id:#somesymbol, text:"Some Text" } or
• array of symbols or objects above;
• onClose - function with the signature function(id, root) returning true|false. This function will be called on attempt to close dialog with parameters id - id of the button pressed and root - root node of the HTML document of the dialog. Function shall return true if dialog can be closed at the moment.
• onLoad - function with the signature function(root). This function will be called after creating dialog window. Use it if you need to do some initialization, e.g. fill data of input fields if text is an html containing <input>s.

1. view.msgbox(#information, "I am fine!"); - will show simple message;  
2. view.msgbox(#question, "Be or not to be?", "Huh?",
[ {id:#yes, text:"To be"}, {id:#no, text:"Not to be"} ] );

closes current view (or dialog if it is view of dialog window). retval is any scripting object - return value of the dialog() function.

Passes control to the operating system. Control is returned after the operating system has finished processing next event in its event queue. This method is used for implementing modal document loops.

In case of:

• #wait - waits for the next event in the UI message queue, default behavior.
• #nowait - if there is any event in message queue handles it and returns immediately if there no any messages;
• #all - executes all pending messeages in the message queue. Returns immediately if there no any messages;

Executes all pending changes in the view and renders what was changed on the screen. After this call box coordinates of all DOM elements are valid.

Use this method when you need to commit all updates made on the DOM to the moment. For example:

function retrieveDataFromDB(recordSet)
{
 while(!recordSet.EOF())
 {
    grid.appendRow(recordSet.row);
    if(++numRowsAdded > 10)
    {
       numRowsAdded = 0;
       view.update();
    }
 }
}

Calls the callback function for each format of data presented in system clipboard at the moment. The callback function has following signature: function ( dataType: symbol ) {...}, where dataType is a symbol designating one of supported formats:

#text

- text/plain, represented bys string

#html

- text/html, represented by string;

#picture

- bitmap image, represented by object of type Image;

#url

- url or link, represented by object of the following structure:  { url: string , caption: string };

#json

- JSON data, represented as an object.

returns integer - clipboard sequence number. Each change of clipboard buffer changes this number.

Fetches data from the clipboard in format defined by the dataType parameter. For list of allowed values see previous method definition.

Note: for the #html format this function returns two values: source url (if any) and html data per se.
To get both of them use this : var (url, html) = view.clipboard(#get, #html);

Stores data to the clipboard.

• false - window is deactivated;
• true - window is activated somehow but not by mouse;
• #by-mouse - window is activated by mouse click on it.