GeoStreamRenderer Class |  |
Learn more about Verizon Connect GeoBase.
Get information about the latest release
Abstract base class for custom renderers that generate custom tile layers for GeoStream.
Inheritance HierarchySystemObject
System.Web.UIControl
System.Web.UITemplateControl
System.Web.UIPage
TileBase
NoUserTileBase
Tile
Telogis.GeoBase.GeoStream.ServerGeoStreamRenderer
System.Web.UIControl
System.Web.UITemplateControl
System.Web.UIPage
TileBase
NoUserTileBase
Tile
Telogis.GeoBase.GeoStream.ServerGeoStreamRenderer
Namespace: Telogis.GeoBase.GeoStream.Server
Assembly: geobase.net (in geobase.net.dll) Version: 4.99.0.0
SyntaxThe GeoStreamRenderer type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | Application | Gets the HttpApplicationState object for the current Web request. (Inherited from Page.) |
| AppRelativeTemplateSourceDirectory | Gets or sets the application-relative virtual directory of the Page or UserControl object that contains this control. (Inherited from Control.) |
| AppRelativeVirtualPath | Gets or sets the application-relative, virtual directory path to the file from which the control is parsed and compiled. (Inherited from TemplateControl.) |
| AsyncTimeout | Gets or sets a value indicating the time-out interval used when processing asynchronous tasks. (Inherited from Page.) |
| AutoPostBackControl | Gets or sets the control in the page that is used to perform postbacks. (Inherited from Page.) |
| BindingContainer | Gets the control that contains this control's data binding. (Inherited from Control.) |
| Bounds |
Returns the bounds for the area covered by the renderer. If a tile is requested outside
this area a tile will not be generated, potentially increasing performance.
|
| Buffer | Sets a value indicating whether the page output is buffered. (Inherited from Page.) |
| Cache | Gets the Cache object associated with the application in which the page resides. (Inherited from Page.) |
| CacheId |
A unique indentifier for the renderer. This is used by the geostream server as part of
the serverside cache-key. If the tile being drawn was requested with some metadata e.g.
request time, then that parameter must be manually appended here. May contain only
filename-friendly characters. Defaults to string.Empty.
|
| ClientID | Gets the control ID for HTML markup that is generated by ASP.NET. (Inherited from Control.) |
| ClientIDMode | Gets or sets the algorithm that is used to generate the value of the ClientID property. (Inherited from Control.) |
| ClientQueryString | Gets the query string portion of the requested URL. (Inherited from Page.) |
| ClientScript | Gets a ClientScriptManager object used to manage, register, and add script to the page. (Inherited from Page.) |
| ClientTarget | Gets or sets a value that allows you to override automatic detection of browser capabilities and to specify how a page is rendered for particular browser clients. (Inherited from Page.) |
| CodePage | Sets the code page identifier for the current Page. (Inherited from Page.) |
| ContentType | Sets the HTTP MIME type for the HttpResponse object associated with the page. (Inherited from Page.) |
| Controls | Gets a ControlCollection object that represents the child controls for a specified server control in the UI hierarchy. (Inherited from Control.) |
| Culture | Sets the culture ID for the Thread object associated with the page. (Inherited from Page.) |
| DataDependentCache |
Indicates whether the generated tiles depend on the currently loaded gbfs files. If this
is overridden to return true then the tiles will be cached with the current dataset as
part of the cache-key. Defaults to false.
|
| DataItemContainer | Gets a reference to the naming container if the naming container implements IDataItemContainer. (Inherited from Control.) |
| DataKeysContainer | Gets a reference to the naming container if the naming container implements IDataKeysControl. (Inherited from Control.) |
| EnableEventValidation | Gets or sets a value indicating whether the page validates postback and callback events. (Inherited from Page.) |
| EnableTheming | Gets or sets a Boolean value indicating whether themes apply to the control that is derived from the TemplateControl class. (Inherited from TemplateControl.) |
| EnableViewState | Gets or sets a value indicating whether the page maintains its view state, and the view state of any server controls it contains, when the current page request ends. (Inherited from Page.) |
| EnableViewStateMac | Gets or sets a value indicating whether ASP.NET should check message authentication codes (MAC) in the page's view state when the page is posted back from the client. (Inherited from Page.) |
| ErrorPage | Gets or sets the error page to which the requesting browser is redirected in the event of an unhandled page exception. (Inherited from Page.) |
| ExpiresAfter |
Indicates how long the rendered tiles are to stay in the GeoStream's tile-cache.
This must be at least one minute.
|
| Form | Gets the HTML form for the page. (Inherited from Page.) |
| Header | Gets the document header for the page if the head element is defined with a runat=server in the page declaration. (Inherited from Page.) |
| ID | Gets or sets an identifier for a particular instance of the Page class. (Inherited from Page.) |
| IdSeparator | Gets the character used to separate control identifiers when building a unique ID for a control on a page. (Inherited from Page.) |
| IsAsync | Gets a value indicating whether the page is processed asynchronously. (Inherited from Page.) |
| IsCallback | Gets a value that indicates whether the page request is the result of a callback. (Inherited from Page.) |
| IsCrossPagePostBack | Gets a value indicating whether the page is involved in a cross-page postback. (Inherited from Page.) |
| IsPostBack | Gets a value that indicates whether the page is being rendered for the first time or is being loaded in response to a postback. (Inherited from Page.) |
| IsPostBackEventControlRegistered | Gets a value that indicates whether the control in the page that performs postbacks has been registered. (Inherited from Page.) |
| IsReusable | Gets a value indicating whether the Page object can be reused. (Inherited from Page.) |
| IsValid | Gets a value indicating whether page validation succeeded. (Inherited from Page.) |
| Items | Gets a list of objects stored in the page context. (Inherited from Page.) |
| LCID | Sets the locale identifier for the Thread object associated with the page. (Inherited from Page.) |
| MaintainScrollPositionOnPostBack | Gets or sets a value indicating whether to return the user to the same position in the client browser after postback. This property replaces the obsolete SmartNavigation property. (Inherited from Page.) |
| Master | Gets the master page that determines the overall look of the page. (Inherited from Page.) |
| MasterPageFile | Gets or sets the virtual path of the master page. (Inherited from Page.) |
| MaxPageStateFieldLength | Gets or sets the maximum length for the page's state field. (Inherited from Page.) |
| MetaDescription | Gets or sets the content of the "description" meta element. (Inherited from Page.) |
| MetaKeywords | Gets or sets the content of the "keywords" meta element. (Inherited from Page.) |
| NamingContainer | Gets a reference to the server control's naming container, which creates a unique namespace for differentiating between server controls with the same ID property value. (Inherited from Control.) |
| Page | Gets a reference to the Page instance that contains the server control. (Inherited from Control.) |
| PageAdapter | Gets the adapter that renders the page for the specific requesting browser. (Inherited from Page.) |
| Parent | Gets a reference to the server control's parent control in the page control hierarchy. (Inherited from Control.) |
| PreviousPage | Gets the page that transferred control to the current page. (Inherited from Page.) |
| RenderingCompatibility | Gets a value that specifies the ASP.NET version that rendered HTML will be compatible with. (Inherited from Control.) |
| Request | Gets the HttpRequest object for the requested page. (Inherited from Page.) |
| RequiredRendermodes |
Returns the stage when the custom renderer draws on tiles.
|
| Response | Gets the HttpResponse object associated with the Page object. This object allows you to send HTTP response data to a client and contains information about that response. (Inherited from Page.) |
| ResponseEncoding | Sets the encoding language for the current HttpResponse object. (Inherited from Page.) |
| RouteData | Gets the RouteData value of the current RequestContext instance. (Inherited from Page.) |
| Server | Gets the Server object, which is an instance of the HttpServerUtility class. (Inherited from Page.) |
| Session | Gets the current Session object provided by ASP.NET. (Inherited from Page.) |
| Site | Gets information about the container that hosts the current control when rendered on a design surface. (Inherited from Control.) |
| SkinID | Gets or sets the skin to apply to the control. (Inherited from Control.) |
| SmartNavigation | Obsolete. Gets or sets a value indicating whether smart navigation is enabled. This property is deprecated. (Inherited from Page.) |
| StyleSheetTheme | Gets or sets the name of the theme that is applied to the page early in the page life cycle. (Inherited from Page.) |
| TemplateControl | Gets or sets a reference to the template that contains this control. (Inherited from Control.) |
| TemplateSourceDirectory | Gets the virtual directory of the Page or UserControl that contains the current server control. (Inherited from Control.) |
| Theme | Gets or sets the name of the page theme. (Inherited from Page.) |
| Title | Gets or sets the title for the page. (Inherited from Page.) |
| Trace | Gets the TraceContext object for the current Web request. (Inherited from Page.) |
| TraceEnabled | Sets a value indicating whether tracing is enabled for the Page object. (Inherited from Page.) |
| TraceModeValue | Sets the mode in which trace statements are displayed on the page. (Inherited from Page.) |
| UICulture | Sets the user interface (UI) ID for the Thread object associated with the page. (Inherited from Page.) |
| UniqueID | Gets the unique, hierarchically qualified identifier for the server control. (Inherited from Control.) |
| User | Gets information about the user making the page request. (Inherited from Page.) |
| Validators | Gets a collection of all validation controls contained on the requested page. (Inherited from Page.) |
| ViewStateEncryptionMode | Gets or sets the encryption mode of the view state. (Inherited from Page.) |
| ViewStateMode | Gets or sets the view-state mode of this control. (Inherited from Control.) |
| ViewStateUserKey | Assigns an identifier to an individual user in the view-state variable associated with the current page. (Inherited from Page.) |
| Visible | Gets or sets a value indicating whether the Page object is rendered. (Inherited from Page.) |
Methods| Name | Description | |
|---|---|---|
 | AddOnPreRenderCompleteAsync(BeginEventHandler, EndEventHandler) | Registers beginning and ending event handler delegates that do not require state information for an asynchronous page. (Inherited from Page.) |
| AddOnPreRenderCompleteAsync(BeginEventHandler, EndEventHandler, Object) | Registers beginning and ending event handler delegates for an asynchronous page. (Inherited from Page.) |
| ApplyStyleSheetSkin | Applies the style properties defined in the page style sheet to the control. (Inherited from Control.) |
| DataBind | Binds a data source to the invoked server control and all its child controls. (Inherited from Control.) |
| DesignerInitialize | Performs any initialization of the instance of the Page class that is required by RAD designers. This method is used only at design time. (Inherited from Page.) |
| Dispose | Enables a server control to perform final clean up before it is released from memory. (Inherited from Control.) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| ExecuteRegisteredAsyncTasks | Starts the execution of an asynchronous task. (Inherited from Page.) |
| FindControl | Searches the page naming container for a server control with the specified identifier. (Inherited from Page.) |
| Focus | Sets input focus to a control. (Inherited from Control.) |
| GetDataItem | Gets the data item at the top of the data-binding context stack. (Inherited from Page.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetPostBackClientEvent | Obsolete. Gets a reference that can be used in a client event to post back to the server for the specified control and with the specified event arguments. (Inherited from Page.) |
| GetPostBackClientHyperlink | Obsolete. Gets a reference, with javascript: appended to the beginning of it, that can be used in a client event to post back to the server for the specified control and with the specified event arguments. (Inherited from Page.) |
| GetPostBackEventReference(Control) | Obsolete. Returns a string that can be used in a client event to cause postback to the server. The reference string is defined by the specified Control object. (Inherited from Page.) |
| GetPostBackEventReference(Control, String) | Obsolete. Returns a string that can be used in a client event to cause postback to the server. The reference string is defined by the specified control that handles the postback and a string argument of additional event information. (Inherited from Page.) |
| GetRouteUrl(Object) | Gets the URL that corresponds to a set of route parameters. (Inherited from Control.) |
| GetRouteUrl(RouteValueDictionary) | Gets the URL that corresponds to a set of route parameters. (Inherited from Control.) |
| GetRouteUrl(String, Object) | Gets the URL that corresponds to a set of route parameters and a route name. (Inherited from Control.) |
| GetRouteUrl(String, RouteValueDictionary) | Gets the URL that corresponds to a set of route parameters and a route name. (Inherited from Control.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| GetTypeHashCode | Retrieves a hash code that is generated by Page objects that are generated at run time. This hash code is unique to the Page object's control hierarchy. (Inherited from Page.) |
| GetUniqueIDRelativeTo | Returns the prefixed portion of the UniqueID property of the specified control. (Inherited from Control.) |
| GetValidators | Returns a collection of control validators for a specified validation group. (Inherited from Page.) |
| HasControls | Determines if the server control contains any child controls. (Inherited from Control.) |
| IsClientScriptBlockRegistered | Obsolete. Determines whether the client script block with the specified key is registered with the page. (Inherited from Page.) |
| IsStartupScriptRegistered | Obsolete. Determines whether the client startup script is registered with the Page object. (Inherited from Page.) |
| LoadControl(String) | Loads a Control object from a file based on a specified virtual path. (Inherited from TemplateControl.) |
| LoadControl(Type, Object) | Loads a Control object based on a specified type and constructor parameters. (Inherited from TemplateControl.) |
| LoadTemplate | Obtains an instance of the ITemplate interface from an external file. (Inherited from TemplateControl.) |
| MapPath | Retrieves the physical path that a virtual path, either absolute or relative, or an application-relative path maps to. (Inherited from Page.) |
| ParseControl(String) | Parses an input string into a Control object on the Web Forms page or user control. (Inherited from TemplateControl.) |
| ParseControl(String, Boolean) | Parses an input string into a Control object on the ASP.NET Web page or user control. (Inherited from TemplateControl.) |
| ProcessRequest | Sets the intrinsic server objects of the Page object, such as the Context, Request, Response, and Application properties. (Inherited from Page.) |
| ReadStringResource | Reads a string resource. The ReadStringResource method is not intended for use from within your code. (Inherited from TemplateControl.) |
| RegisterArrayDeclaration | Obsolete. Declares a value that is declared as an ECMAScript array declaration when the page is rendered. (Inherited from Page.) |
| RegisterAsyncTask | Registers a new asynchronous task with the page. (Inherited from Page.) |
| RegisterClientScriptBlock | Obsolete. Emits client-side script blocks to the response. (Inherited from Page.) |
| RegisterHiddenField | Obsolete. Allows server controls to automatically register a hidden field on the form. The field will be sent to the Page object when the HtmlForm server control is rendered. (Inherited from Page.) |
| RegisterOnSubmitStatement | Obsolete. Allows a page to access the client OnSubmit event. The script should be a function call to client code registered elsewhere. (Inherited from Page.) |
| RegisterRequiresControlState | Registers a control as one whose control state must be persisted. (Inherited from Page.) |
| RegisterRequiresPostBack | Registers a control as one that requires postback handling when the page is posted back to the server. (Inherited from Page.) |
| RegisterRequiresRaiseEvent | Registers an ASP.NET server control as one requiring an event to be raised when the control is processed on the Page object. (Inherited from Page.) |
| RegisterRequiresViewStateEncryption | Registers a control with the page as one requiring view-state encryption. (Inherited from Page.) |
| RegisterStartupScript | Obsolete. Emits a client-side script block in the page response. (Inherited from Page.) |
| RegisterViewStateHandler | Causes page view state to be persisted, if called. (Inherited from Page.) |
| Render |
If the requested tile was not found in the tile-cache, this method is called to perform
the drawing operation. Drawing is conducted on a supertile basis.
|
| RenderControl | Outputs server control content to a provided HtmlTextWriter object and stores tracing information about the control if tracing is enabled. (Inherited from Control.) |
| RequiresControlState | Determines whether the specified Control object is registered to participate in control state management. (Inherited from Page.) |
| ResolveClientUrl | Gets a URL that can be used by the browser. (Inherited from Control.) |
| ResolveUrl | Converts a URL into one that is usable on the requesting client. (Inherited from Control.) |
| SetFocus(Control) | Sets the browser focus to the specified control. (Inherited from Page.) |
| SetFocus(String) | Sets the browser focus to the control with the specified identifier. (Inherited from Page.) |
| SetRenderMethodDelegate | Assigns an event handler delegate to render the server control and its content into its parent control. (Inherited from Control.) |
| TestDeviceFilter | Returns a Boolean value indicating whether a device filter applies to the HTTP request. (Inherited from TemplateControl.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| UnregisterRequiresControlState | Stops persistence of control state for the specified control. (Inherited from Page.) |
| Validate | Instructs any validation controls included on the page to validate their assigned information. (Inherited from Page.) |
| Validate(String) | Instructs the validation controls in the specified validation group to validate their assigned information. (Inherited from Page.) |
| VerifyRenderingInServerForm | Confirms that an HtmlForm control is rendered for the specified ASP.NET server control at run time. (Inherited from Page.) |
Events| Name | Description | |
|---|---|---|
 | AbortTransaction | Occurs when a user ends a transaction. (Inherited from TemplateControl.) |
| CommitTransaction | Occurs when a transaction completes. (Inherited from TemplateControl.) |
| DataBinding | Occurs when the server control binds to a data source. (Inherited from Control.) |
| Disposed | Occurs when a server control is released from memory, which is the last stage of the server control lifecycle when an ASP.NET page is requested. (Inherited from Control.) |
| Error | Occurs when an unhandled exception is thrown. (Inherited from TemplateControl.) |
| Init | Occurs when the server control is initialized, which is the first step in its lifecycle. (Inherited from Control.) |
| InitComplete | Occurs when page initialization is complete. (Inherited from Page.) |
| Load | Occurs when the server control is loaded into the Page object. (Inherited from Control.) |
| LoadComplete | Occurs at the end of the load stage of the page's life cycle. (Inherited from Page.) |
| PreInit | Occurs before page initialization. (Inherited from Page.) |
| PreLoad | Occurs before the page Load event. (Inherited from Page.) |
| PreRender | Occurs after the Control object is loaded but prior to rendering. (Inherited from Control.) |
| PreRenderComplete | Occurs before the page content is rendered. (Inherited from Page.) |
| SaveStateComplete | Occurs after the page has completed saving all view state and control state information for the page and controls on the page. (Inherited from Page.) |
| Unload | Occurs when the server control is unloaded from memory. (Inherited from Control.) |
RemarksOverride this class to define a custom GeoStream renderer. You must implement the abstract Render(Graphics, RenderContext) method to draw the tiles of your custom layer and implement the abstract ExpiresAfter property to indicate how long the tiles can remain in the GeoStream tile cache.
Your GeoStreamRenderer class should be added to an aspx file which is placed in the renderers folder of the GeoStream server. (The renderers folder must be created at the root directory of your GeoStream tile server.)
Related articles: Geostream renderers, Rendering your own tiles.
See Also