OpenWindow Class Content Studio 5.7 SDK
Content Studio Web Content Management System

[This is preliminary documentation and is subject to change.]

Writes a link or button with an open window script fragment in the supplied stream or the default response stream. The script is activated on the click event, opens a new window and loads the document specified by a given URL. The OpenWindow class acts as the underlying engine for the Open Window AS component.
Inheritance Hierarchy

SystemObject
  ContentStudio.SiteCodeBase
    ContentStudio.Site.ActiveScriptingActiveScriptingBase
      ContentStudio.Site.ActiveScriptingDocumentBase
        ContentStudio.Site.ActiveScripting.DocumentOpenWindow

Namespace: ContentStudio.Site.ActiveScripting.Document
Assembly: CS_SiteLib (in CS_SiteLib.dll) Version: 5.7.5016.0 (5.7.5016.0)
Syntax

public sealed class OpenWindow : DocumentBase

The OpenWindow type exposes the following members.

Constructors

  NameDescription
Public methodOpenWindow
Constructs a new instance of the OpenWindow class that writes to the default response stream
Public methodOpenWindow(Stream)
Constructs a new instance of the OpenWindow class that writes to the supplied stream
Top
Properties

  NameDescription
Public propertyBackwardsComponentCompatibilityMode
Sets or gets a value that indicates whether the code runs in backwards compatibility component mode. The default value is false.
(Inherited from ActiveScriptingBase.)
Public propertyClassName
Sets or gets the name of the CSS style class to use to format the generated link or button. The default value is an empty string (no specfic CSS style class selected).
Public propertyComponentName
Gets the name of the component
(Overrides ActiveScriptingBaseComponentName.)
Public propertyConformance
Gets a value which specifies which type of code a component can generate.
(Overrides ActiveScriptingBaseConformance.)
Public propertyDocumentID
Sets or gets a value that indicates which document to display (using the ID as reference). The default value is zero (no document is displayed).
Public propertyElementType
Gets a value which specifies the type of outer element the component generates.
(Overrides ActiveScriptingBaseElementType.)
Public propertyEncoding
Sets or gets the encoding the component uses. The default encoding is the UTF8 encoding without byte order mark.
(Inherited from ActiveScriptingBase.)
Public propertyHeight
Sets or gets a value that indicates the height in pixels of the window to display. The minimum allowed value is 100. The default value is 150.
Public propertyIsChannelMode
Sets or gets a value that specifies if channel mode should be used. The default value is false (channel mode is not used).
Public propertyIsFullScreenMode
Sets or gets a value that specifies whether to display the browser in full-screen mode or not. The default value is false (not using full-screen mode). Use full-screen mode carefully, because this mode hides the browsers title bar and menus. You should always provide a button or other some other visual indicator to help the user close the window (keys ALT+F4 closes the new window).
Public propertyLeft
Sets or gets a value that indicates the left position, measured in pixels, of the window to display. This value cannot be negative. The default value is 100.
Public propertyLinkAsButton
Sets or gets a value that specifies if the link to open the new window should be a button or a regular link. The default value is false (create it as a regular link).
Public propertyPresentationTemplateID
Sets or gets a value that indicates the presentation template (that formats the EPT document indicated by the DocumentID property) that Content Studio will display. The default value is zero (no presentation template is used).
Public propertyReplaceInHistoryList
Sets or gets a value that specifies whether the URL creates a new entry or replaces the current entry in the windows history list. This value is used when the URL is loaded into the same window. The default value is true (create a new entry).
Public propertyResizable
Sets or gets that specifies whether to display resize handles at the corners of the window or not. The default value is false (no resizable handles).
Public propertyShowDirectoryButtons
Sets or gets a value that specifies whether to add directory buttons or not. The default value is true.
Public propertyShowLocation
Sets or gets a value that specifies whether to display or omit the input field for entering URL in the browser. The default value is true (display the URL input field).
Public propertyShowMenuBar
Sets or gets a value specifies whether to display the menu bar or not. The default value is true (display the menu bar).
Public propertyShowScrollbars
Sets or gets a value that specifies whether to display scroll bars or not. The default value is true (show scroll bars).
Public propertyShowStatusbar
Sets or gets a value that specifies whether to add a status bar at the bottom of the window or not. The default value is true (add the status bar).
Public propertyShowTitlebar
Sets or gets a value that specifies whether to display a title bar for the window or not. The default value is true (display the title bar). This parameter is ignored unless the calling application is an HTML application or a trusted dialog box.
Public propertyShowToolbar
Sets or gets a value that specifies whether to display a tool bar for the window or not. The default value is false (do not display the tool bar). This parameter is ignored unless the calling application is an HTML application or a trusted dialog box.
Public propertyText
Sets or gets the text to display in the button or link that opens the window. The default value is an empty string.
Public propertyTop
Sets or gets a value that indicates the top position, measured in pixels, of the window to display. This value cannot be negative. The default value is 100.
Public propertyWidth
Sets or gets a value that indicates the width, measured in pixels, of the window to display. The minimum allowed value is 100. The default value is 200.
Public propertyWindowName
Sets or gets a value that specifies the name of the window. The default value is an empty string. The property is optional. This name is used as the value for the target attribute on a form or an anchor element (<a>). Possible values are: _self: The current document is replaced with the specified URL. _top: The URL replaces any framesets that may be loaded. If there are no framesets defined, this value acts as the value _self. _parent: The URL is loaded into parent of the current frame. If the frame has no parent, this value acts as the value _self. _blank: The URL is loaded into a new, unnamed window. _search: The URL is opened in the browsers search pane. Available in Microsoft® Internet Explorer 5 and later.
Top
Methods

  NameDescription
Public methodEquals (Inherited from Object.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Public methodInvoke
Invokes the component and writes its content into the specified stream
Public methodToString (Inherited from Object.)
Top
Remarks

To use this class, create an instance of this object, set up the properties and call the Invoke method with an appropriate set of parameters. This class can throw exceptions, thus your code should be wrapped within try/catch statements in order to avoid the entire page to crash. This class generates inline code, thus you must wrap it into a block element to make the page validate according to the HTML/XHTML regulations. The generated code is fully HTML/XHTML strict compatible.
See Also

Reference