ASP.NET 3.5 and above only

Obout.Ajax.UI Controls - HTML Editor - Server side

Obout.Ajax.UI.HTMLEditor.Popups.ImportDocumentPopup class

 Inheritance Hierarchy

<%@ Register Assembly="Obout.Ajax.UI" Namespace="Obout.Ajax.UI.HTMLEditor.Popups" TagPrefix="obout" %>

The popup of this class is opened on top toolbar's button click.

Public properties

Name Description
propertyAdditionalCss String. Gets or sets comma separated paths of additional CSS files for this popup. (Inherited from Popup.)
propertyAvailableExtensions String overridable. Gets semicolon separated file extensions available for uploading and importing. (Inherited from GalleryManager.)
The value is calculating depending on the DocumentReaders property.
Default "txt;html".
propertyAutoDimensions Bool sealed. Gets a value indicating whether the size of the popup is determining automatically. (Inherited from Popup.)
Always true.
propertyClientID String. Gets the server control identifier generated by ASP.NET. (Inherited from Control.)
propertyCssPath String. Gets or sets a style file path. (Inherited from Popup.)
By default embedded CSS file is used.
propertyDescriptionExtension String. Gets or sets the extension of description files. (Inherited from GalleryManager.)
The full name of the description file is formed with appending this extension to the full name of the target file.
For example, the "MyFile.ext" file can have a description file named "MyFile.ext.description".
If the description file exists for the selected file, then its text content is shown in the preview panel of the Gallery Manager.
If this property is set to empty, then no description files will be used at all.

Default "description".
propertyDocumentReaders String overridable. Gets or sets semicolon separated document descriptors for importing files. Each document descriptor is a class name of a 'reader' for the document, the class name should have one or more prefixes - available file extension ended with ':' character.
If the value of the property is started with '+' character, then this value will be added to the previously defined (default) value.
Example:
DocumentReaders="+doc:docx:MsWordDocumentReader"

Default
"txt:Obout.Ajax.UI.HTMLEditor.Popups.TxtReader; html:Obout.Ajax.UI.HTMLEditor.Popups.HtmlReader".

Also see Document readers.
propertyDuplicateFileMessage String overridable. Gets the text for an alert window when the user tries to create a folder with duplicate name. (Inherited from GalleryManager.)
propertyGalleryFolders String overridable. Gets or sets semicolon separated relative URL's of gallery folders. (Inherited from GalleryManager.)
Default "~/App_Obout/HTMLEditor/DocumentsGallery".
propertyGalleryNames String overridable. Gets or sets semicolon separated gallery names associated with the GalleryFolders property. (Inherited from GalleryManager.)
Default "Documents Gallery".
propertyID String. Gets or sets the programmatic identifier assigned to the server control. (Inherited from Control.)
propertyInvalidFileExtensionMessage String overridable. Gets the text for an alert window when the user tries to upload a file with invalid extension. (Inherited from GalleryManager.)
propertyInvalidFileNameMessage String overridable. Gets the text for an alert window when the user tries to create a folder with invalid name. (Inherited from GalleryManager.)
propertyManagedFolders String overridable. Gets or sets semicolon separated relative URL's of folders available for managing - new folders creating, uploading and deleting files. (Inherited from GalleryManager.)
Default "~/App_Obout/HTMLEditor/DocumentsGallery/users_documents".
propertyOboutTree Obout.Ajax.UI.TreeView.Tree. Gets the inner obout ASP.NET Tree control, null if UseOboutTree is set to false. (Inherited from GalleryManager.)
About keyboard navigation in the obout Tree control see this page.

This class instance has the following properties set by default:

CssClass = "vista"
EnableKeyBoardSupport = true
EnableDragAndDrop = false (can not be changed)
EnableMultiNodeSelection = false (can not be changed)
EnableViewState = false (can not be changed)
EnableTheming = false (can not be changed)
LeafNodeStyle.NodeCSS = "internalLeafNodeCSS" (embedded CSS class)
OnNodeSelect = "OboutTree_SelectNode" (can not be changed)

Example:

<obout:PopupHolder runat="server" ID="popupHolder"
  <Demand
     <obout:ImportDocumentPopup runat="server" UseOboutTree="true"
                                      
OboutTree-CssClass="default" />
  </
Demand>
</
obout:PopupHolder>
propertyPredefinedLinksFile String overriden. Gets an empty string always here. (Inherited from UrlBrowser.)
propertyRelativeUrl Bool. Gets or sets a value indicating whether to create a ralative URL for selected file (image, document etc.). - unusable here. (Inherited from GalleryManager.)
propertyShowPreviewPanel Bool. Gets or sets a value indicating whether to show the preview panel in the popup. (Inherited from GalleryManager.)
Default true.
propertyTreeFeatures TreeFeatures. Gets an instance of the class with additional properties for the Tree control used in the Gallery Manger. (Inherited from GalleryManager.)

Example:

<obout:PopupHolder runat="server" ID="popupHolder"
  <Demand
    <obout:ImportDocumentPopup runat="server" UseOboutTree="true"> 
      <TreeFeatures FolderImageUrl="~/treeview/icons/folder_old.gif"  
        <LeafImages
          <obout:LeafImage Extensions="html"
                                     
Url="~/treeview/icons/ie_link.gif" /> 
          <obout:LeafImage Extensions="txt"
                                     
Url="~/treeview/img/vista_note.png" /> 
          <obout:LeafImage Extensions="*"
                                     
Url="~/treeview/icons/square_yellowS.gif" />  
        </LeafImages
      </TreeFeatures
    </obout:ImportDocumentPopup
  </Demand>
</
obout:PopupHolder>
propertyTreeView System.Web.UI.WebControls.TreeView. Gets the inner standard ASP.NET Tree control, null if UseOboutTree is set to true. (Inherited from GalleryManager.)

This class instance has the following properties set by default:

LeafNodeStyle.ForeColor = "Blue"
NodeStyle.ForeColor = "Black"
NodeStyle.Font.Size = "11px"
NodeStyle.Font.Name = "verdana"
NodeStyle.NodeSpacing = "0px"
SelectedNodeStyle.BackColor = "Blue"
SelectedNodeStyle.ForeColor = "Yellow"

Example:

<obout:PopupHolder runat="server" ID="popupHolder"
  <Demand
     <obout:ImportDocumentPopup runat="server"
                                                   TreeView-Font-Bold="true"/>
  </
Demand>
</
obout:PopupHolder>
propertyUseOboutTree Bool. Gets or set a value indicating whether to use the obout ASP.NET Tree control in the Gallery Manager.
If false then the standard ASP.NET TreeView is used. (Inherited from GalleryManager.)
Default false.

Example:

<obout:PopupHolder runat="server" ID="popupHolder"
  <Demand
     <obout:ImportDocumentPopup runat="server" UseOboutTree="true" />
  </
Demand>
</
obout:PopupHolder>
 

Protected properties

Name Description
propertyAddFolderButton AddFolderButton overridable. Gets the "Add a new folder" button from the popup. (Inherited from GalleryManager.)
propertyAttachedToButton Bool sealed. Gets a value indicating whether the popup is 'attached' to a button called this popup. (Inherited from Popup.)
Always false.
propertyAutoClose Bool sealed. Gets a value indicating whether the popup is closed on click outside it. (Inherited from Popup.)
Always false.
propertyClientControlType String overridable. Gets the script type to use for the Control. (Inherited from Popup.)
propertyContent Collection<Control>. Gets collection of controls included into the popup. (Inherited from Popup.)
propertyDefaultTitle String overridable. Gets the popup title if not found in Localization. (Inherited from Popup.)
propertyDeleteButton DeleteButton overridable. Gets the "Delete selected item" button from the popup. (Inherited from GalleryManager.)
propertyIframe HtmlGenericControl overridable. Gets the iframe control where the gallery tree is rendered. (Inherited from GalleryManager.)
propertyIframePreview HtmlGenericControl overridable. Gets the iframe control where the preview information (for the highlighted item) is rendered. (Inherited from GalleryManager.)
propertyRefreshButton RefreshButton overridable. Gets the "Refresh" button from the popup. (Inherited from GalleryManager.)
propertyUploadButton UploadButton overridable. Gets the "Upload a new flash" button from the popup. (Inherited from GalleryManager.)
Default UploadButton control with the RelatedPopup property set to UploadDocumentPopup .
propertyScriptPath String overridable. Gets the path of the script file where the associated script type is defined. (Inherited from Popup.)

Protected methods

Name Description
propertyExecAddFolderCommand Void overridable. Adds a new folder to the managed folder. (Inherited from GalleryManager.)
Parameters:
  • String url - URL of the new folder.
  • String name - file/folder name.
propertyExecDeleteCommand Void overridable. Deletes file/folder from the managed folder. (Inherited from GalleryManager.)
Parameters:
  • String url - URL of the file/folder.
  • String name - name of the new folder.
propertySaveUploadedFile Void overridable. Saves an uploaded file to the managed folder. (Inherited from GalleryManager.)
Parameters:
  • String folder - folder URL where to save.
  • String name - name of the file.
  • String title - files' description.
  • HttpPostedFile file - uploaded file.

"The Grid control is very cool. I've got about a thousand uses for it if I can master it. "

Rette Alexander
Rayonier Information Technology

Random testimonial   All testimonials