Intersoft WebDesktop Documentation
WebDesktopWindow
Send Feedback
Intersoft WebDesktop > Client-side References > WebDesktopWindow

Glossary Item Box

 WebDesktopWindow Properties

AllowMinimize Description
Gets or sets whether minimizing WebDesktopWindow control is allowed.

ValueType
String

Default Value
"Default"
AllowMaximize Description
Gets or sets whether maximizing WebDesktopWindow control is allowed.

ValueType
String

Default Value
"Default"
AllowResize Description
Gets or sets whether resizing WebDesktopWindow control is allowed.

ValueType
String

Default Value
"Default"
AllowClose Description
Gets or sets whether closing WebDesktopWindow control is allowed.

ValueType
String

Default Value
"Default"
ControlBox Description
Gets or sets the value indicating whether a control box is displayed in the caption bar of the WebDesktopWindow.

ValueType
Boolean

Default Value

Text Description
Gets or sets the text caption displayed in the WebDesktopWindow control.

ValueType
String

Default Value

TextAlignment Description
Gets or sets the text alignment displayed in the WebDesktopWindow control.

ValueType
String

Default Value

CaptionDisplayMode Description
Gets or sets the display mode of the caption of WebDesktopWindow.

ValueType
String

Default Value

ContentMode Description
Gets or sets whether the content of this Window is using native HTML content or IFrame.

ValueType
String

Default Value

ClientVisible Description
Indicates whether the WebDesktopWindow is visible in the client side at initialization.

ValueType
Boolean

Default Value

Size Description
The size of the WebDesktopWindow control.

ValueType
UnitSize

Default Value

MaximumSize Description
The Maximum size of the WebDesktopWindow control.

ValueType
UnitSize

Default Value

MinimumSize Description
The Minimum size of the WebDesktopWindow control.

ValueType
UnitSize

Default Value

Location Description
Gets or sets the location of WebDesktopWindow control.

ValueType
String

Default Value

Name Description
Gets the name of the WebDesktopWindow control.

ValueType
String

Default Value

InProgressText Description
Gets or sets the text of the InProgressText.

ValueType
String

Default Value

ShowInTaskBar Description
Indicates whether to show the WebDesktopWindow in task bar.

ValueType
Boolean

Default Value

ControlBoxImage Description
Gets or sets the image displayed in the WebDesktopWindow control.

ValueType
String

Default Value

ShortcutImage Description
Gets or sets the image that will be used in WebDesktopShortcut that links to this window.

ValueType
String

Default Value

Index Description
Gets or sets the index of the WebDialogBoxButton object.

ValueType
String

Default Value

DesktopManager Description
Gets or sets the DesktopManager instance associated with WebDialogBoxButton control.

ValueType
DesktopManager

Default Value

ContentURL Description
Gets or sets the URL string of a page that will be displayed inside the container (Window, Pane, Tab).

ValueType
String

Default Value

Collection Description
Gets the Collection that contains the WebDesktopWindow.

ValueType
Array

Default Value

IsClosed Description
Indicates whether or not the WebDesktopWindow is closed.

ValueType
Boolean

Default Value

Initialized Description
Indicates whether or not the WebDesktopWindow has been initialized.

ValueType
Boolean

Default Value

IFrameContentLoaded Description
Indicates whether or not the IFrame content has been loaded.

ValueType
Boolean

Default Value

WindowState Description
Gets or sets the WebDesktopWindow's state

ValueType
Boolean

Default Value

CreatedAtRuntime Description
Indicates whether or not the WebDesktopWindow is created at runtime.

ValueType
Boolean

Default Value

DialogBoxShown Description
Determines whether the dialog box should be shown.

ValueType
Boolean

Default Value

CurrentDialogBox Description
Gets the currently active dialog box owned by the WebDesktopWindow.

ValueType
WebDialogBox

Default Value

 WebDesktopWindow Methods

GetWindowDivElement Description
Gets the HTML Div element of this WebDesktopWindow

Parameters

Remarks

Return Value
object (HTML Element)


Samples

 

GetCaptionBarCellElement Description
Gets the HTML caption bar cell element of WebDesktopWindow

Parameters

Remarks

Return Value
object (HTML Element)



Samples

 

GetControlBoxElement Description
Gets the HTML ControlBox element of WebDesktopWindow

Parameters

Remarks

Return Value
object (HTML Element)



Samples

 

GetCaptionBarTableElement Description
Gets the HTML Caption Bar Table element of WebDesktopWindow

Parameters

Remarks

Return Value
object (HTML Element)



Samples

 

GetInProgressText Description
Gets the progress text of this WebDesktopWindow

Parameters

Remarks

Return Value
String


Samples
 
GetContentDivElement Description
Gets the HTML Content Div Element of this WebDesktopWindow

Parameters

Remarks

Return Value
object (HTML Element)



Samples

 

GetDesktopManager Description
Gets the DesktopManager object where this WebDesktopWindow is created

Parameters

Remarks

Return Value
object (DesktopManager)



Samples

 

GetWindowOptionsCellElement Description
Gets the HTML Window Options Element of this WebDesktopWindow

Parameters

Remarks

Return Value
object (HTML Element)



Samples

 

GetControlBoxCellElement Description
Gets the HTML Control Box Cell Element of this WebDesktopWindow

Parameters

Remarks

Return Value
object (HTML Element)



Samples

 

GetMaximizeButtonElement Description
Gets the HTML Maximize Button Element of this WebDesktopWindow

Parameters

Remarks

Return Value
object (HTML Element)


Samples
 
GetCloseButtonElement Description
Gets the HTML Close Button Element of this WebDesktopWindow

Parameters

Remarks

Return Value
object (HTML Element)



Samples

 

GetMinimizeButtonElement Description
Gets the HTML Minimize ButtonElement of this WebDesktopWindow

Parameters

Remarks

Return Value
object (HTML Element)


Samples
 
IsActiveWindow Description
Check whether this WebDesktopWindow is the active window

Parameters

Remarks

Return Value
boolean


Samples
 
GetTaskBarButtonElement Description
Gets the HTML TaskBar Button Element of this WebDesktopWindow

Parameters

Remarks

Return Value
object (HTML Element)



Samples

 

GetWindowIFrameElement Description
Gets the HTML Window IFrame element of WebDesktop

Parameters

Remarks

Return Value
object (HTML Element)


Samples
 
MoveTo Description
Move this WebDesktopWindow to specific location that has been specified from the parameters

Parameters
x ( int )
   the x coordinate of where this window will be moved
y ( int )
   the y coordinate of where this window will be moved

Remarks


Return Value

Samples
MoveToCenterDesktop Description
Move the position of this WebDesktopWindow to the center of the desktop

Parameters

Remarks

Return Value


Samples

 

ResizeTo Description
Resize this WebDesktopWindow to specific width and height from the parameters

Parameters
width ( unit )
   The width of the Window wants to be resized to
height ( unit )
   The height of the Window wants to be resized to


Remarks


Return Value


Samples

 

Minimize Description
Minimize WebDesktopWindow

Parameters
raiseEvent ( boolean )
   An inidicator of whether this minimize action will rise an event
runAnimation ( boolean )
   An inidicator of whether this minimize action will run any animation


Remarks


Return Value


Samples

 

Maximize Description
Maximize this WebDesktopWindow

Parameters
raiseEvent ( boolean )
   An inidicator of whether this maximize action will rise an event
runAnimation ( boolean )
   An inidicator of whether this maximize action will run any animation


Remarks


Return Value


Samples

 

Restore Description
Restore this WebDesktopWindow

Parameters
raiseEvent ( boolean )
   An inidicator of whether this restore action will rise an event

runAnimation ( boolean )
   An inidicator of whether this restore action will run any animation


Remarks


Return Value


Samples

 

Close Description
Close this WebDesktopWindow

Parameters
raiseEvent ( boolean )
   An inidicator of whether this close action will rise an event


Remarks


Return Value


Samples

 

Activate Description
Activate this WebDesktopWindow

Parameters

Remarks

Return Value


Samples

 

Show Description
Show this WebDesktopWindow

Parameters
shortcutDiv ( HTML element )
   The HTML element of the shortcut


Remarks


Return Value


Samples

 

Hide Description
Hide this WebDesktopWindow

Parameters

Remarks

Return Value


Samples

 

BringToFront Description
Bring this WebDesktopWindow to the front of other windows

Parameters

Remarks

Return Value

Samples
 
SendToBack Description
Send this WebDesktopWindow to the back of other windows

Parameters

Remarks

Return Value


Samples

 

SetCaption Description
Sets the caption of this WebDesktopWindow

Parameters
text ( String )
   The text that will be set as the caption of this WebDesktopWindow


Remarks


Return Value


Samples

 

SetControlBoxImage Description
Sets the control box image of this WebDesktopWindow

Parameters
imgURL ( String )
   The image url that will be set as the ControlBoxImage


Remarks


Return Value


Samples

 

SetContentURL Description
Sets the content URL of this WebDesktopWindow

Parameters
url ( String )
   The content url that will be set as the content url

Remarks


Return Value


Samples

 

LoadContent Description
Load the content of the Window

Parameters

Remarks

Return Value

Samples
 
SaveLocationAndSize Description
Save the location and size of this window

Parameters

Remarks

Return Value


Samples

 

IsTargetSizeValid Description
Check whether the Target size passed from the parameter is a valid size

Parameters
width ( unit )
the width of the target size
height ( unit )
the height of the target size


Remarks

Return Value


Samples

 

GetPreferredSize Description
Gets the preferred size of this Window

Parameters
width ( unit )
   The width of the preferred size
height ( unit )
   The height of the preferred size


Remarks


Return Value


Samples

 

GetNextWindow Description
Gets the next window from the parent WebDesktopManager

Parameters

Remarks

Return Value


Samples

 

GetPreviousWindow Description
Gets the previous window from the parent WebDesktopManager

Parameters

Remarks

Return Value


Samples

 

SetInlineContent Description
Sets the inline content from this WebDesktopWindow

Parameters
strHTML ( HTML element )
   The String HTML to be set as the Inline Content for this WebDesktopWindow instance


Remarks


Return Value


Samples

 

SetBusy

Description
Sets the WebDesktopWindow to be busy

Parameters


Remarks


Return Value


Samples

 

SetIdle Description
Sets the WebDesktopWindow to be Idle

Parameters


Remarks


Return Value


Samples

 

© 2012 Intersoft Solutions Corp. All Rights Reserved.