ESRI.ArcGIS.ADF.Web.UI.WebControls.Layout
PageLayout Class Members
See Also  Fields  Properties  Methods  Events
ESRI.ArcGIS.ADF.Web.UI.WebControls.Layout Namespace : PageLayout Class




The following tables list the members exposed by PageLayout.

Public Constructors

 NameDescription
Public ConstructorPageLayout Constructor Constructor for the PageLayout control.  
Top

Public Fields

 NameDescription
Public FieldStateManager All state management is done through this property. (Inherited from ESRI.ArcGIS.ADF.Web.UI.WebControls.WebControl)
Top

Protected Fields

 NameDescription
Protected Field_callbackArg Stores the callback argument passed in to RaiseCallbackEvent. Used in GetCallbackResult to process the callback request. (Inherited from ESRI.ArcGIS.ADF.Web.UI.WebControls.WebControl)
Top

Public Properties

 NameDescription
Public PropertyAccessKey Not Used by CartoDisplay (Inherited from ESRI.ArcGIS.ADF.Web.UI.WebControls.CartoDisplay)
Public PropertyAppRelativeTemplateSourceDirectory (Inherited from System.Web.UI.Control)
Public PropertyAttributes (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyBackColor (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyBorderColor (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyBorderStyle (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyBorderWidth Gets or sets the border width of the Web server control. (Inherited from ESRI.ArcGIS.ADF.Web.UI.WebControls.CartoDisplay)
Public PropertyCallbackResults A collection of CallbackResult objects for passing information from the server to the client during a callback. (Inherited from ESRI.ArcGIS.ADF.Web.UI.WebControls.WebControl)
Public PropertyClientID (Inherited from System.Web.UI.Control)
Public PropertyClientToolGraphicsColor The color of the box drawn on the Map/PageLayout control display while using the DragRectangle or PageDragRectangle Client Action tools (while zooming in/out, for example). (Inherited from ESRI.ArcGIS.ADF.Web.UI.WebControls.CartoDisplay)
Public PropertyClientToolGraphicsWidth Line width of shapes dragged on the PageLayout/Map controls while using a Tool. (Inherited from ESRI.ArcGIS.ADF.Web.UI.WebControls.CartoDisplay)
Public PropertyControls (Inherited from System.Web.UI.Control)
Public PropertyControlStyle (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyControlStyleCreated (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyCopyrightText The copyright text to display on the page layout image in the control.  
Public PropertyCssClass Gets or sets the Cascading Style Sheet (CSS) class rendered by the Web server control on the client. (Inherited from ESRI.ArcGIS.ADF.Web.UI.WebControls.CartoDisplay)
Public PropertyCurrentToolItemOverridden.  The current toolitem that can be used on the control.  
Public PropertyDataFrameOverridden.  The specified DataFrame used in the published Map Document  
Public PropertyDataSourceType Data Source Type.  
Public PropertyEnableContinuousCallbackWhether to request map tiles asynchronously as the user pans the map.  
Public PropertyEnabled Indicates whether the web control is enabled. This property is not used. (Inherited from ESRI.ArcGIS.ADF.Web.UI.WebControls.CartoDisplay)
Public PropertyEnableTheming (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyEnableViewState Indicates whether the server control persists its view state, and the view state of any child controls it contains, to the requesting client. (Inherited from ESRI.ArcGIS.ADF.Web.UI.WebControls.CartoDisplay)
Public PropertyExtent The current extent set on the Map control.  
Public PropertyFont The font used in the WebControl. This property is not used. (Inherited from ESRI.ArcGIS.ADF.Web.UI.WebControls.CartoDisplay)
Public PropertyForeColor The ForeColor of the WebControl. This property is not used. (Inherited from ESRI.ArcGIS.ADF.Web.UI.WebControls.CartoDisplay)
Public PropertyHasAttributes (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyHeight (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyHost The ArcGIS Server machine.  
Public PropertyID (Inherited from System.Web.UI.Control)
Public PropertyImageFormat The format of the image generated by the control in web-tier blending scenarios. (Inherited from ESRI.ArcGIS.ADF.Web.UI.WebControls.CartoDisplay)
Public PropertyInitialExtent The initial extent at which a control first renders. (Inherited from ESRI.ArcGIS.ADF.Web.UI.WebControls.CartoDisplay)
Public PropertyIsAsync Returns true if this control is in a partial postback or a callback. (Inherited from ESRI.ArcGIS.ADF.Web.UI.WebControls.WebControl)
Public PropertyLayoutImage The Image displayed by the PageLayout control and its properties.  
Public PropertyMapFunctionalities Conveniently access the functionalities of the resources of the Page.  
Public PropertyMapScalesOverridden.  The specified map scales for the maps  
Public PropertyNamingContainer (Inherited from System.Web.UI.Control)
Public PropertyOutputDirectoryThe path to the directory where any output images will be written.  
Public PropertyPage (Inherited from System.Web.UI.Control)
Public PropertyPageDescription The string representation of the PageDescription for this page layout.  
Public PropertyPageEncryptIdentity The encrypted identity.  
Public PropertyPageIdentity The identity.  
Public PropertyPageLayoutResourceDefines the server and map resource used in the page layout.  
Public PropertyParent (Inherited from System.Web.UI.Control)
Public PropertyRotationAngleRotation angle for the page. Not currently used.  
Public PropertyScrollWheelZoom Whether the map can be zoomed using the mouse scroll wheel.  
Public PropertyServerObjectOverridden.  The name of the ServerObject being used in the ArcGIS Server  
Public PropertySite (Inherited from System.Web.UI.Control)
Public PropertySkinID (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertySpatialReference Properties of the spatial reference in which the MapResources will be displayed.  
Public PropertyStyle (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyTabIndex Not Used by CartoDisplay (Inherited from ESRI.ArcGIS.ADF.Web.UI.WebControls.CartoDisplay)
Public PropertyTemplateControl (Inherited from System.Web.UI.Control)
Public PropertyTemplateSourceDirectory (Inherited from System.Web.UI.Control)
Public PropertyToolItemsOverridden. Collection of tool items that can be used on the control.  
Public PropertyToolTip (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyUniqueID (Inherited from System.Web.UI.Control)
Public PropertyUseDefaultWebResources If true, the control will use the internal web resources within the assemblies of the Web ADF. If false, the control uses the resources at WebResourceLocation. (Inherited from ESRI.ArcGIS.ADF.Web.UI.WebControls.WebControl)
Public PropertyUseMimeData Whether the Web application will send map images to the browser as a stream of bytes if possible, or if false, as an image file. (Inherited from ESRI.ArcGIS.ADF.Web.UI.WebControls.CartoDisplay)
Public PropertyVirtualDirectory The path to the virtual directory in which images can be written, for example, ~/output/. Output directory must exist on disk at the location the virtual directory maps to.  
Public PropertyVisible (Inherited from System.Web.UI.Control)
Public PropertyWebResourceLocation The location of the web resources used by the ADF Web control if UseDefaultWebResrouces is false. (Inherited from ESRI.ArcGIS.ADF.Web.UI.WebControls.WebControl)
Public PropertyWidth (Inherited from System.Web.UI.WebControls.WebControl)
Top

Protected Properties

 NameDescription
Protected PropertyAdapter (Inherited from System.Web.UI.Control)
Protected PropertyBrowserName The name of the calling browser. (Inherited from ESRI.ArcGIS.ADF.Web.UI.WebControls.CartoDisplay)
Protected PropertyBrowserSupportsJavascript Indicates whether Javascript is supported by the calling browser. (Inherited from ESRI.ArcGIS.ADF.Web.UI.WebControls.CartoDisplay)
Protected PropertyCallbackFunctionString Gets the callbackfunction string for this control instance. (Inherited from ESRI.ArcGIS.ADF.Web.UI.WebControls.WebControl)
Protected PropertyChildControlsCreated (Inherited from System.Web.UI.Control)
Protected PropertyClientIDSeparator (Inherited from System.Web.UI.Control)
Protected PropertyContext (Inherited from System.Web.UI.Control)
Protected PropertyDesignMode (Inherited from System.Web.UI.Control)
Protected PropertyEvents (Inherited from System.Web.UI.Control)
Protected PropertyHasChildViewState (Inherited from System.Web.UI.Control)
Protected PropertyIdSeparator (Inherited from System.Web.UI.Control)
Protected PropertyIsAtRenderStage Returns true if this control is called through an asynchronous callback, or the refresh flag has been set and the page is in partial postback mode. (Inherited from ESRI.ArcGIS.ADF.Web.UI.WebControls.WebControl)
Protected PropertyIsChildControlStateCleared (Inherited from System.Web.UI.Control)
Protected PropertyIsEnabled (Inherited from System.Web.UI.WebControls.WebControl)
Protected PropertyIsTrackingViewState (Inherited from System.Web.UI.Control)
Protected PropertyIsViewStateEnabled (Inherited from System.Web.UI.Control)
Protected PropertyLoadViewStateByID (Inherited from System.Web.UI.Control)
Protected PropertyTagKey Gets the HTML tag for the control. (Inherited from ESRI.ArcGIS.ADF.Web.UI.WebControls.CartoDisplay)
Protected PropertyTagName (Inherited from System.Web.UI.WebControls.WebControl)
Protected PropertyViewState (Inherited from System.Web.UI.Control)
Protected PropertyViewStateIgnoresCase (Inherited from System.Web.UI.Control)
Top

Public Methods

 NameDescription
Public MethodApplyStyle (Inherited from System.Web.UI.WebControls.WebControl)
Public MethodApplyStyleSheetSkin (Inherited from System.Web.UI.Control)
Public MethodCenterAtCenters the map at the specified point.  
Public MethodCenterMapAtCenters the map in the data frame at the specified point.  
Public MethodCopyBaseAttributes (Inherited from System.Web.UI.WebControls.WebControl)
Public MethodDataBindOverloaded.  (Inherited from System.Web.UI.Control)
Public MethodDispose (Inherited from System.Web.UI.Control)
Public MethodDraw Draws the page layout image using existing settings. This is a shortcut for creating a WebPageLayout using CreateWebPageLayout, calling Refresh on it and then disposing the WebPageLayout.  
Public MethodFindControlOverloaded.  (Inherited from System.Web.UI.Control)
Public MethodFocus (Inherited from System.Web.UI.Control)
Public MethodGetCallbackResultOverridden. Returns the results of the client callback.  
Public MethodgetMapContentsOverridden.  Get layer names.  
Public MethodGetScriptDescriptors Gets a collection of script descriptors that represent JavaScript client components. (Inherited from ESRI.ArcGIS.ADF.Web.UI.WebControls.WebControl)
Public MethodGetScriptReferences Returns a list of required clientside scripts for this webcontrol, based on the class' script attributes (Inherited from ESRI.ArcGIS.ADF.Web.UI.WebControls.WebControl)
Public MethodHasControls (Inherited from System.Web.UI.Control)
Public MethodLoadPostDataOverridden.  Indicates whether RaisePostDataChangedEvent should be called.  
Public MethodMergeStyle (Inherited from System.Web.UI.WebControls.WebControl)
Public MethodRaiseCallbackEvent As part of the callback implementation for the control, stores the event argument passed to the control by the client. (Inherited from ESRI.ArcGIS.ADF.Web.UI.WebControls.WebControl)
Public MethodRaisePostBackEventOverridden.  Handles postbacks. Raises events based on the passed-in eventargument. Calls the ServerToolAction component of the Current ToolItem.  
Public MethodRaisePostDataChangedEventOverridden.  Enables a server control to process an event raised when a form is posted to the server.  
Public MethodRefreshOverridden.  Draws the page layout image using existing settings. This is a shortcut for creating a WebPageLayout using CreateWebPageLayout, calling Refresh on it and then disposing the WebPageLayout.  
Public MethodRenderBeginTag (Inherited from System.Web.UI.WebControls.WebControl)
Public MethodRenderControlOverloaded.  (Inherited from System.Web.UI.Control)
Public MethodRenderEndTag (Inherited from System.Web.UI.WebControls.WebControl)
Public MethodReset Reset object to an un-bound state  
Public MethodResolveClientUrl (Inherited from System.Web.UI.Control)
Public MethodResolveUrl (Inherited from System.Web.UI.Control)
Public MethodSetLayerVisibilityOverridden.  Change the visibility of a layer in the page layout.  
Public MethodSetRenderMethodDelegate (Inherited from System.Web.UI.Control)
Public MethodZoomZooms the map in the layout in or out based on the screen rectangle.  
Public MethodZoomMapToFullExtentZooms the map out to the extent of all map layers.  
Public MethodZoomToFullExtentSets the layout to the full page view.  
Public MethodZoomToFullSize Zooms the page to a scale of 1:1, the same scale as if the page were exported to a print document.  
Top

Protected Methods

 NameDescription
Protected MethodAddAttributesToRenderOverridden.  The UniqueID of this control is set as its name here.  
Protected MethodAddedControl (Inherited from System.Web.UI.Control)
Protected MethodAddParsedSubObject (Inherited from System.Web.UI.Control)
Protected MethodBuildProfileTree (Inherited from System.Web.UI.Control)
Protected MethodClearChildControlState (Inherited from System.Web.UI.Control)
Protected MethodClearChildState (Inherited from System.Web.UI.Control)
Protected MethodClearChildViewState (Inherited from System.Web.UI.Control)
Protected MethodCreateChildControls (Inherited from System.Web.UI.Control)
Protected MethodCreateControlCollection (Inherited from System.Web.UI.Control)
Protected MethodCreateControlStyle (Inherited from System.Web.UI.WebControls.WebControl)
Protected MethodDataBindChildren (Inherited from System.Web.UI.Control)
Protected MethodEnsureChildControls (Inherited from System.Web.UI.Control)
Protected MethodEnsureID (Inherited from System.Web.UI.Control)
Protected MethodFinalizeOverridden.  PageLayout control's finalizer.  
Protected MethodGetClientFileUrl Gets the url for an embedded file in the assembly. (Inherited from ESRI.ArcGIS.ADF.Web.UI.WebControls.CartoDisplay)
Protected MethodGetDesignModeState (Inherited from System.Web.UI.Control)
Protected MethodGetDesignModeWarningsOverridden.  Returns a list of warning messages to be displayed at design time.  
Protected MethodHasEvents (Inherited from System.Web.UI.Control)
Protected MethodIsLiteralContent (Inherited from System.Web.UI.Control)
Protected MethodLoadControlState (Inherited from System.Web.UI.Control)
Protected MethodLoadViewStateOverridden.  Overridden to handle view state for complex properties.  
Protected MethodMapPathSecure (Inherited from System.Web.UI.Control)
Protected MethodOnBeginCreateWebPageLayout Raises the BeginCreateWebPageLayout event.  
Protected MethodOnBubbleEvent (Inherited from System.Web.UI.Control)
Protected MethodOnContentsChanged Raises the ContentsChanged event.  
Protected MethodOnDataBinding (Inherited from System.Web.UI.Control)
Protected MethodOnDragImage Raises the DragImage event.  
Protected MethodOnDragRectangle Raises the DragRectangle event.  
Protected MethodOnExtentChange Raises the ExtentChanged event.  
Protected MethodOnInitOverridden.  If you set DrawInitialExtent to True, the control's LayoutImage property is populated here using the full extent of the layout. This happens the first time the control is drawn in a session.

Raises the Init event.

 
Protected MethodOnLoad (Inherited from System.Web.UI.Control)
Protected MethodOnMapDragImage Raises the MapDragImage event.  
Protected MethodOnMapDragRectangle Raises the MapDragRectangle event.  
Protected MethodOnMapPoint Raises the MapPoint event.  
Protected MethodOnPageClick Raises the PageClick event.  
Protected MethodOnPoint Raises the Point event.  
Protected MethodOnPreRenderOverridden. Raises the PreRender event.  
Protected MethodOnRefresh Raises the OnRefresh event.  
Protected MethodOnScaleChange Raises the ScaleChanged event.  
Protected MethodOnUnload Saves the control's state and raises the Unload event. (Inherited from ESRI.ArcGIS.ADF.Web.UI.WebControls.WebControl)
Protected MethodOpenFile (Inherited from System.Web.UI.Control)
Protected MethodRaiseBubbleEvent (Inherited from System.Web.UI.Control)
Protected MethodRemovedControl (Inherited from System.Web.UI.Control)
Protected MethodRender Renders the control. (Inherited from ESRI.ArcGIS.ADF.Web.UI.WebControls.WebControl)
Protected MethodRenderChildren (Inherited from System.Web.UI.Control)
Protected MethodRenderContentsOverridden.  Renders the contents of the control to the specified writer. This method is used primarily by control developers.  
Protected MethodRenderDesignModeWarnings If design mode is active and the derived class has configuration errors, then a standard template will be used to show these errors to the user and True is returned, else no warnings are displayed and false is returned. (Inherited from ESRI.ArcGIS.ADF.Web.UI.WebControls.WebControl)
Protected MethodResolveAdapter (Inherited from System.Web.UI.Control)
Protected MethodSaveControlState (Inherited from System.Web.UI.Control)
Protected MethodSaveViewStateOverridden.  Overridden to handle viewstate for complex properties.  
Protected MethodSetDesignModeState (Inherited from System.Web.UI.Control)
Protected MethodTrackViewStateOverridden.  Overridden to handle viewstate for complex properties.  
Top

Public Events

 NameDescription
Public EventBeginCreateWebPageLayout Occurs before a WebPageLayout is created  
Public EventBeginDisposeWebPageLayout Occurs before a WebPageLayout is disposed  
Public EventBeginRefreshWebPageLayout Occurs before a WebPageLayout is refreshed  
Public EventContentsChanged Occurs when the contents of this control (e.g. the extent) have changed.  
Public EventDataBinding (Inherited from System.Web.UI.Control)
Public EventDisposed (Inherited from System.Web.UI.Control)
Public EventDragImage Occurs when the image in the PageLayout control has been dragged using the DragImage client tool action.  
Public EventDragRectangle Occurs when a rectangle has been dragged on the PageLayout control using the DragRectangle client tool action.  
Public EventEndCreateWebPageLayout Occurs after a WebPageLayout is created  
Public EventEndDisposeWebPageLayout Occurs after a WebPageLayout is disposed  
Public EventEndRefreshWebPageLayout Occurs after a WebPageLayout is refreshed  
Public EventExtentChanged Occurs when the extent of the pagelayout has changed.  
Public EventInit (Inherited from System.Web.UI.Control)
Public EventLoad (Inherited from System.Web.UI.Control)
Public EventMapDragImage Occurs when a data frame in the PageLayout control has been dragged using the MapDragImage client tool action.  
Public EventMapDragRectangle Occurs when a rectangle has been dragged on a dataframe in the PageLayout control using the MapDragRectangle client tool action.  
Public EventMapPoint Occurs when a data frame in the PageLayout control has been clicked upon using the MapPoint client tool action.  
Public EventPageClick Occurs when the PageLayout control has been clicked.  
Public EventPoint Occurs when the PageLayout control has been clicked using the Point client tool action.  
Public EventPreRender (Inherited from System.Web.UI.Control)
Public EventRefreshed Occurs when the pagelayout is refreshed.  
Public EventScaleChanged Occurs when the scale of the map on the layout has changed.  
Public EventUnload (Inherited from System.Web.UI.Control)
Top

See Also

© 2010 All Rights Reserved.