iMySobek_Admin_Viewer Interface
Interface defines the required behavior for the mySobek and administrative viewers
Namespace: SobekCM.Library.AdminViewerAssembly: SobekCM_Library (in SobekCM_Library.dll) Version: 4.10.0.0 (4.10.0.0)
Syntax
C# |
---|
public interface iMySobek_Admin_Viewer |
Methods
| Name | Description |
---|
| Add_Controls | Add controls directly to the form in the main control area placeholder |
| Add_Popup_HTML | Add the HTML to be added near the top of the page for those viewers that implement pop-up forms for data retrieval |
| Write_HTML | Add the HTML to be displayed in the main SobekCM viewer area (outside of any form) |
| Write_ItemNavForm_Closing | This is an opportunity to write HTML directly into the main form after any controls are placed |
| Write_ItemNavForm_Opening | This is an opportunity to write HTML directly into the main form before any controls are placed in the main place holder |
| Write_Within_HTML_Head | Write any additional values within the HTML Head of the final served page |
Properties
| Name | Description |
---|
| Container_CssClass | Gets the CSS class of the container that the page is wrapped within |
| Contains_Popup_Forms | Property indicates if this mySobek viewer can contain pop-up forms |
| Requires_Logged_In_User | Flag indicates if a user must be logged in to access this
admin or mySobek view. |
| Standard_Navigation_Type | Navigation type to be displayed (mostly used by the mySobek viewers) |
| Upload_File_Possible | Returns a flag indicating whether the file upload specific holder in the itemNavForm form will be utilized
for the current request, or if it can be hidden/omitted. |
| Viewer_Behaviors | Gets the collection of special behaviors which this admin or mySobek viewer
requests from the main HTML subwriter. |
| Viewer_Icon | Gets the URL for the icon related to this administrative task |
| Web_Title | Title for the page that displays this viewer, this is shown in the search box at the top of the page, just below the banner |
See Also