3.1.5.3.17.1 dialogview
The dialogview request is used by a client to obtain an HTML-rendered view of the document libraries within a site, a specific document library, or a folder within a document library, which is used in a dialog box for opening or saving files; or opens the property form that is used when saving a file.
Tokens
dialogview: Specifies the view to display. Possible values include the following. <53>
|
Mask |
Meaning |
|---|---|
|
FileOpen |
The Open dialog box. The server MUST return an HTML document formatted to render a file open dialog; it SHOULD NOT encourage users to select documents that do not exist. |
|
FileSave |
The Save dialog box. The server MUST return an HTML document formatted to render a file save dialog; it SHOULD allow for picking an existing document or creating a new one. |
|
SaveForm |
The Property form. To view the property form used when saving a file, the location parameter specifies the file in the document library. Clients conforming to the FrontPage Server Extensions Remote Protocol MUST NOT use this value for the dialogview parameter. The server MAY treat this as any other nonsupported value. |
|
All other values |
The server MUST return an HTTP 410 (GONE) response. |
location: Specifies the site-relative URL of a document library or of a folder or file within a document library. If SaveForm is specified in dialogview, the URL for the location parameter MUST point to the file being saved. If the location parameter is passed without specifying a value, this method SHOULD display a view of all the document libraries in the site.
FileDialogFilterValue: Specifies the file type extension by which to filter the view in the file dialog box (for example, *.doc, *.txt, or *.htm).
URL
TPScriptURL
Return Values
Success: Displays the view of a document library or folder that is used in a file dialog box, in all document libraries in the site, or in the form used to specify document properties when saving a file.
Error: If the server requires further authentication or authorization, it MUST trigger the HTTP layer to return a 401 message, access denied. The HTTP layer on the client and server then manages authenticating the user. Otherwise, if the request has the dialogview parameter but has some other error (for example, if the location or dialogview parameters are not valid), the server MUST send a 410 GONE response. The client conforming to the subset of the protocol described here MUST send the dialogview parameter to any request to TPScriptURL.
If the result is not an error, the server's response MUST contain an HTML table whose identifier is "FileDialogView". Each file that the server wants to show the client MUST be represented as a TR element in the table that has an identifier containing the complete URL of the file to be represented and has an expando property fileattribute="file". The server MUST repeat this for each folder, except that it has the fileattribute="folder" expando property.
If the result is an error, the HTTP return value MUST be 410 (GONE), and the server MAY add contents that, if present, SHOULD be an HTML-formatted error message for display to an end user.
The client SHOULD render the HTML returned by the server, detect mouse clicks and other selection gestures that it wants to respond to, and use the HTML document object model to determine the TR on which the selection occurred. If the user selects a folder, the client SHOULD make a new dialogview request with the location specified by the folder. If the user selects a file, the client SHOULD treat that as the file the user wants to open or save over.
If the client gets an error, it MAY fall back to an alternate dialog method (potentially populated by the list documents (section 3.1.5.3.8) method) or present the error to the user.