CMS.PortalEngine.xml
<?xml version="1.0"?>
<doc> <assembly> <name>CMS.PortalEngine</name> </assembly> <members> <member name="T:CMS.PortalEngine.CssEventArgs"> <summary> The object of this class is used to pass CSS preprocessing arguments to a callback method. </summary> </member> <member name="P:CMS.PortalEngine.CssEventArgs.Code"> <summary> Stylesheet code. </summary> </member> <member name="P:CMS.PortalEngine.CssEventArgs.ErrorMessage"> <summary> Error message. </summary> </member> <member name="P:CMS.PortalEngine.CssEventArgs.WarningMessage"> <summary> Warning message. </summary> </member> <member name="T:CMS.PortalEngine.CssPreprocessor"> <summary> The object of this class maintains information about CSS preprocessor. </summary> </member> <member name="P:CMS.PortalEngine.CssPreprocessor.CurrentCompiledValue"> <summary> Gets or sets the current compiled value. </summary> </member> <member name="P:CMS.PortalEngine.CssPreprocessor.Name"> <summary> Machine-friendly name of the CSS preprocessor. </summary> </member> <member name="P:CMS.PortalEngine.CssPreprocessor.Extension"> <summary> File extension associated with the preprocessor. </summary> </member> <member name="P:CMS.PortalEngine.CssPreprocessor.DisplayName"> <summary> Name of the preprocessor displayed in the user interface. </summary> </member> <member name="P:CMS.PortalEngine.CssPreprocessor.Callback"> <summary> Callback function that performs CSS processing. The function consumes CssEventArg object and returns the processed CSS as a string. </summary> </member> <member name="P:CMS.PortalEngine.CssPreprocessor.RegisterClientCompilationScripts"> <summary> Callback action that renders a script that will be used for client side compilation. </summary> </member> <member name="P:CMS.PortalEngine.CssPreprocessor.GetErrorDescription"> <summary> Callback method that returns error description according to preprocessor's nature. String representing error output of JavaScript compiler is passed as the first argument. </summary> </member> <member name="P:CMS.PortalEngine.CssPreprocessor.UsesClientSideCompilation"> <summary> Indicates whether preprocessor uses also client-side compilation. </summary> </member> <member name="T:CMS.PortalEngine.CssStylesheetInfo"> <summary> CSS style sheet info data container class. </summary> </member> <member name="F:CMS.PortalEngine.CssStylesheetInfo.OBJECT_TYPE"> <summary> Object type </summary> </member> <member name="F:CMS.PortalEngine.CssStylesheetInfo.EXTERNAL_COLUMN_CSS"> <summary> External column name for style sheet text. </summary> </member> <member name="F:CMS.PortalEngine.CssStylesheetInfo.EXTERNAL_COLUMN_DYNAMICCODE"> <summary> External column name for style sheet dynamic code. </summary> </member> <member name="F:CMS.PortalEngine.CssStylesheetInfo.PLAIN_CSS"> <summary> The constant represents plain CSS option for stylesheet type. </summary> </member> <member name="F:CMS.PortalEngine.CssStylesheetInfo.CSS_EXTENSION"> <summary> Common CSS file extension. </summary> </member> <member name="F:CMS.PortalEngine.CssStylesheetInfo.TYPEINFO"> <summary> Type information. </summary> </member> <member name="M:CMS.PortalEngine.CssStylesheetInfo.DeleteObject"> <summary> Deletes the object using appropriate provider. </summary> </member> <member name="M:CMS.PortalEngine.CssStylesheetInfo.SetObject"> <summary> Updates the object using appropriate provider. </summary> </member> <member name="M:CMS.PortalEngine.CssStylesheetInfo.GetVirtualFileRelativePath(System.String,System.String)"> <summary> Returns virtual relative path for specific column </summary> <param name="externalColumnName">External column name</param> <param name="versionGuid">Version GUID. If not defined physical path is generated</param> </member> <member name="M:CMS.PortalEngine.CssStylesheetInfo.RegisterExternalColumns"> <summary> Returns path to externally stored CSS Stylesheet codes. </summary> </member> <member name="M:CMS.PortalEngine.CssStylesheetInfo.AllowExternalColumn(System.String)"> <summary> Indicates whether a given column is allowed to be saved externally. </summary> <param name="columnName">Column name</param> <returns>Returns true if column is allowed to be saved externally</returns> </member> <member name="M:CMS.PortalEngine.CssStylesheetInfo.UpdateExternalColumns"> <summary> Updates DB version of externally stored columns with the data from external storage. </summary> </member> <member name="M:CMS.PortalEngine.CssStylesheetInfo.GetValue(System.String)"> <summary> Gets the field value. </summary> <param name="columnName">Column name</param> <returns>The value as an object</returns> </member> <member name="M:CMS.PortalEngine.CssStylesheetInfo.#ctor"> <summary> Constructor, creates an empty CssStyleSheet structure. </summary> </member> <member name="M:CMS.PortalEngine.CssStylesheetInfo.#ctor(System.Data.DataRow)"> <summary> Constructor, creates CssStylesheetInfo object from the given DataRow data. </summary> <param name="dr">Datarow with the class info data</param> </member> <member name="M:CMS.PortalEngine.CssStylesheetInfo.IsPlainCss"> <summary> Indicates whether CSS stylesheet is plain text. </summary> </member> <member name="M:CMS.PortalEngine.CssStylesheetInfo.GetThemePath"> <summary> Gets the theme path for the object </summary> </member> <member name="M:CMS.PortalEngine.CssStylesheetInfo.IsInSite(System.Int32)"> <summary> Check whether CssStylesheet is in site given by id. </summary> <param name="siteId">ID of site to check</param> <returns>Returns true if CssStyleSheet is in site</returns> </member> <member name="M:CMS.PortalEngine.CssStylesheetInfo.GetPermissionName(CMS.DataEngine.PermissionsEnum)"> <summary> Converts PermissionEnum to permission codename which will be checked when CheckPermission() is called. </summary> <param name="permission">Permission to convert to string</param> </member> <member name="M:CMS.PortalEngine.CssStylesheetInfo.CheckPermissionsInternal(CMS.DataEngine.PermissionsEnum,System.String,CMS.Base.IUserInfo,System.Boolean)"> <summary> Checks the permissions of the object. </summary> <param name="permission">Permission type</param> <param name="siteName">Name of the site</param> <param name="userInfo">UserInfo object</param> <param name="exceptionOnFailure">If true, PermissionCheckException is thrown whenever a permission check fails</param> </member> <member name="M:CMS.PortalEngine.CssStylesheetInfo.InsertAsCloneInternal(CMS.DataEngine.CloneSettings,CMS.DataEngine.CloneResult,CMS.DataEngine.BaseInfo)"> <summary> Inserts cloned object to DB. </summary> <param name="settings">Cloning settings</param> <param name="result">Cloning result</param> <param name="originalObject">Original source BaseInfo (object being cloned)</param> </member> <member name="M:CMS.PortalEngine.CssStylesheetInfo.GetExternalColumnExtension"> <summary> The method retrieves the file extension of the stylesheet. </summary> <returns>Returns the file extension as string</returns> </member> <member name="P:CMS.PortalEngine.CssStylesheetInfo.StylesheetID"> <summary> The stylesheet Id. </summary> </member> <member name="P:CMS.PortalEngine.CssStylesheetInfo.StylesheetDisplayName"> <summary> The stylesheet display name. </summary> </member> <member name="P:CMS.PortalEngine.CssStylesheetInfo.StylesheetName"> <summary> The stylesheet name. </summary> </member> <member name="P:CMS.PortalEngine.CssStylesheetInfo.StylesheetText"> <summary> The stylesheet text. </summary> </member> <member name="P:CMS.PortalEngine.CssStylesheetInfo.StylesheetVersionGUID"> <summary> Stylesheet version GUID. </summary> </member> <member name="P:CMS.PortalEngine.CssStylesheetInfo.StylesheetGUID"> <summary> Stylesheet GUID. </summary> </member> <member name="P:CMS.PortalEngine.CssStylesheetInfo.StylesheetLastModified"> <summary> Object last modified. </summary> </member> <member name="P:CMS.PortalEngine.CssStylesheetInfo.StylesheetDynamicCode"> <summary> The stylesheet dynamic code. </summary> </member> <member name="P:CMS.PortalEngine.CssStylesheetInfo.StylesheetDynamicCodeInternal"> <summary> The stylesheet dynamic code straight from the data class without external column mapping. </summary> </member> <member name="P:CMS.PortalEngine.CssStylesheetInfo.StylesheetDynamicLanguage"> <summary> The stylesheet dynamic language. </summary> </member> <member name="P:CMS.PortalEngine.CssStylesheetInfo.UsesExternalStorage"> <summary> Indicates whether the theme path points at an external storage. </summary> </member> <member name="T:CMS.PortalEngine.CssStylesheetInfoProvider"> <summary> Provides access to information about CSS Stylesheet. </summary> </member> <member name="F:CMS.PortalEngine.CssStylesheetInfoProvider.CSS_STYLESHEETS_DIRECTORY"> <summary> CSS stylesheet directory path. </summary> </member> <member name="F:CMS.PortalEngine.CssStylesheetInfoProvider.preprocessorCollection"> <summary> The static collection of CssPreprocessor objects. </summary> </member> <member name="M:CMS.PortalEngine.CssStylesheetInfoProvider.#ctor"> <summary> Constructor. </summary> </member> <member name="M:CMS.PortalEngine.CssStylesheetInfoProvider.GetVirtualObject(System.String)"> <summary> Returns CSS style sheet info for specified path </summary> <param name="path">Path</param> </member> <member name="M:CMS.PortalEngine.CssStylesheetInfoProvider.GetCssStylesheets"> <summary> Returns all CSS stylesheets. </summary> </member> <member name="M:CMS.PortalEngine.CssStylesheetInfoProvider.SetCssStylesheetInfo(CMS.PortalEngine.CssStylesheetInfo)"> <summary> Sets or updates specified CssStylesheetInfo. </summary> <param name="stylesheet">Css stylesheet info object</param> </member> <member name="M:CMS.PortalEngine.CssStylesheetInfoProvider.GetCssStylesheetInfo(System.Int32)"> <summary> Returns CssStylesheetInfo object for specified CssStylesheetID. </summary> <param name="cssStylesheetId">Stylesheet ID</param> </member> <member name="M:CMS.PortalEngine.CssStylesheetInfoProvider.GetCssStylesheetInfo(System.String)"> <summary> Returns CssStylesheetInfo object for specified CssStylesheetName. </summary> <param name="cssStylesheetName">Stylesheet name</param> </member> <member name="M:CMS.PortalEngine.CssStylesheetInfoProvider.DeleteCssStylesheetInfo(CMS.PortalEngine.CssStylesheetInfo)"> <summary> Deletes specified CssStyleSheet. </summary> <param name="cssObject">CssStylesheet object to delete</param> </member> <member name="M:CMS.PortalEngine.CssStylesheetInfoProvider.DeleteCssStylesheetInfo(System.Int32)"> <summary> Deletes specified CssStyleSheet. </summary> <param name="cssStyleSheetId">CssStylesheetId to delete</param> </member> <member name="M:CMS.PortalEngine.CssStylesheetInfoProvider.DeleteCssStylesheetInfo(System.String)"> <summary> Deletes specified CssStyleSheet. </summary> <param name="cssStyleSheetName">CssStylesheetName to delete</param> </member> <member name="M:CMS.PortalEngine.CssStylesheetInfoProvider.Clear(System.Boolean)"> <summary> Clears the hashtable. </summary> <param name="logTasks">If true, web farm tasks are logged</param> </member> <member name="M:CMS.PortalEngine.CssStylesheetInfoProvider.GetCSSStylesheetName(System.String)"> <summary> Returns full CSS stylesheet name from the given virtual CSS stylesheet path. </summary> <param name="url">Virtual CSS stylesheet path</param> </member> <member name="M:CMS.PortalEngine.CssStylesheetInfoProvider.RegisterCssPreprocessor(System.String,System.String,System.String,System.Func{CMS.PortalEngine.CssEventArgs,System.String},System.Action,System.Func{System.String,System.String})"> <summary> Use this method to register custom CSS dynamic language and its parser. </summary> <param name="name">Dynamic language name</param> <param name="extension">File extension associated with the dynamic language</param> <param name="displayName">Dynamic language name used for displaying in the user interface</param> <param name="callback">Callback function which the source CSS code is passed to process</param> <param name="registerClientCompilationScripts">Method that ensures registration of client scripts required for client-side compilation</param> <param name="getErrorDescription">Method used to get formatted error message</param> </member> <member name="M:CMS.PortalEngine.CssStylesheetInfoProvider.RunCssPreprocessor(System.String,System.String)"> <summary> The method processes the CSS code provided as the first argument with CSS preprocessor associated with dynamic language provided as the second argument. </summary> <param name="source">Source CSS code</param> <param name="lang">Dynamic language name</param> </member> <member name="M:CMS.PortalEngine.CssStylesheetInfoProvider.TryParseCss(System.String,System.String,System.String@)"> <summary> Internally calls preprocessor parser and returns error message. </summary> <param name="code">Input code.</param> <param name="parserName">Preprocessor name.</param> <param name="output">Resulting CSS code.</param> </member> <member name="M:CMS.PortalEngine.CssStylesheetInfoProvider.GetCssPreprocessor(System.String)"> <summary> Returns CssPreprocessor object by the preprocessor language provided as the first argument if such exists. </summary> <param name="lang">Preprocessor language</param> </member> <member name="M:CMS.PortalEngine.CssStylesheetInfoProvider.GetCssStylesheetsInternal"> <summary> Returns all CSS stylesheets. </summary> </member> <member name="M:CMS.PortalEngine.CssStylesheetInfoProvider.SetCssStylesheetInfoInternal(CMS.PortalEngine.CssStylesheetInfo)"> <summary> Sets or updates specified CssStylesheetInfo. </summary> <param name="stylesheet">CSS stylesheet info object</param> </member> <member name="M:CMS.PortalEngine.CssStylesheetInfoProvider.GetCssStylesheetInfoInternal(System.Int32)"> <summary> Returns CssStylesheetInfo object for specified CssStylesheetID. </summary> <param name="cssStylesheetId">Stylesheet ID</param> </member> <member name="M:CMS.PortalEngine.CssStylesheetInfoProvider.GetCssStylesheetInfoInternal(System.String)"> <summary> Returns CssStylesheetInfo object for specified CssStylesheetName. </summary> <param name="cssStylesheetName">Stylesheet name</param> </member> <member name="M:CMS.PortalEngine.CssStylesheetInfoProvider.DeleteCssStylesheetInfoInternal(CMS.PortalEngine.CssStylesheetInfo)"> <summary> Deletes specified CssStyleSheet. </summary> <param name="stylesheet">CssStylesheet object to delete</param> </member> <member name="P:CMS.PortalEngine.CssStylesheetInfoProvider.StoreCSSStyleSheetsInExternalStorage"> <summary> Gets or sets the value that indicates whether CSS style sheets should be stored externally </summary> </member> <member name="P:CMS.PortalEngine.CssStylesheetInfoProvider.CSSStylesheetsDirectory"> <summary> Gets the CSS stylesheet directory path. </summary> </member> <member name="P:CMS.PortalEngine.CssStylesheetInfoProvider.CssPreprocessors"> <summary> Represents the collection of CSS preprocessors. </summary> </member> <member name="T:CMS.PortalEngine.CssStylesheetSiteInfo"> <summary> Css stylesheet site binding info. </summary> </member> <member name="F:CMS.PortalEngine.CssStylesheetSiteInfo.OBJECT_TYPE"> <summary> Object type </summary> </member> <member name="F:CMS.PortalEngine.CssStylesheetSiteInfo.TYPEINFO"> <summary> Type information. </summary> </member> <member name="M:CMS.PortalEngine.CssStylesheetSiteInfo.DeleteObject"> <summary> Deletes the object using appropriate provider. </summary> </member> <member name="M:CMS.PortalEngine.CssStylesheetSiteInfo.SetObject"> <summary> Updates the object using appropriate provider. </summary> </member> <member name="M:CMS.PortalEngine.CssStylesheetSiteInfo.#ctor"> <summary> Constructor - Creates an empty CssStylesheetSiteInfo object. </summary> </member> <member name="M:CMS.PortalEngine.CssStylesheetSiteInfo.#ctor(System.Data.DataRow)"> <summary> Constructor - Creates a new CssStylesheetSiteInfo object from the given DataRow. </summary> </member> <member name="M:CMS.PortalEngine.CssStylesheetSiteInfo.GetPermissionName(CMS.DataEngine.PermissionsEnum)"> <summary> Converts PermissionEnum to permission codename which will be checked when CheckPermission() is called. </summary> <param name="permission">Permission to convert to string</param> </member> <member name="P:CMS.PortalEngine.CssStylesheetSiteInfo.SiteID"> <summary> Site ID. </summary> </member> <member name="P:CMS.PortalEngine.CssStylesheetSiteInfo.StylesheetID"> <summary> Stylesheet ID. </summary> </member> <member name="T:CMS.PortalEngine.CssStylesheetSiteInfoProvider"> <summary> Class providing CssStylesheetSiteInfo management. </summary> </member> <member name="M:CMS.PortalEngine.CssStylesheetSiteInfoProvider.GetCssStylesheetSiteInfo(System.Int32,System.Int32)"> <summary> Returns the CssStylesheetSiteInfo structure for the specified cssStylesheetSite. </summary> <param name="stylesheetId">StylesheetID</param> <param name="siteId">SiteID</param> </member> <member name="M:CMS.PortalEngine.CssStylesheetSiteInfoProvider.SetCssStylesheetSiteInfo(CMS.PortalEngine.CssStylesheetSiteInfo)"> <summary> Sets (updates or inserts) specified cssStylesheetSite. </summary> <param name="cssStylesheetSite">CssStylesheetSite to set</param> </member> <member name="M:CMS.PortalEngine.CssStylesheetSiteInfoProvider.DeleteCssStylesheetSiteInfo(CMS.PortalEngine.CssStylesheetSiteInfo)"> <summary> Deletes specified cssStylesheetSite. </summary> <param name="infoObj">CssStylesheetSite object</param> </member> <member name="M:CMS.PortalEngine.CssStylesheetSiteInfoProvider.RemoveCssStylesheetFromSite(System.Int32,System.Int32)"> <summary> Removes CSS stylesheet from site. </summary> <param name="stylesheetId">StylesheetID</param> <param name="siteId">SiteID</param> </member> <member name="M:CMS.PortalEngine.CssStylesheetSiteInfoProvider.AddCssStylesheetToSite(System.Int32,System.Int32)"> <summary> Adds the class to the specified site. </summary> <param name="stylesheetId">StylesheetID</param> <param name="siteId">SiteID</param> </member> <member name="M:CMS.PortalEngine.CssStylesheetSiteInfoProvider.GetCssStylesheetSites"> <summary> Returns all CSS stylesheet bindings to site. </summary> </member> <member name="M:CMS.PortalEngine.CssStylesheetSiteInfoProvider.GetCssStylesheetSitesInternal"> <summary> Returns all CSS stylesheet bindings to site. </summary> </member> <member name="M:CMS.PortalEngine.CssStylesheetSiteInfoProvider.GetCssStylesheetSiteInfoInternal(System.Int32,System.Int32)"> <summary> Returns the CssStylesheetSiteInfo structure for the specified cssStylesheetSite. </summary> <param name="stylesheetId">StylesheetID</param> <param name="siteId">SiteID</param> </member> <member name="M:CMS.PortalEngine.CssStylesheetSiteInfoProvider.SetCssStylesheetSiteInfoInternal(CMS.PortalEngine.CssStylesheetSiteInfo)"> <summary> Sets (updates or inserts) specified cssStylesheetSite. </summary> <param name="cssStylesheetSite">CssStylesheetSite to set</param> </member> <member name="M:CMS.PortalEngine.CssStylesheetSiteInfoProvider.DeleteCssStylesheetSiteInfoInternal(CMS.PortalEngine.CssStylesheetSiteInfo)"> <summary> Deletes specified cssStylesheetSite. </summary> <param name="infoObj">CssStylesheetSite object</param> </member> <member name="T:CMS.PortalEngine.CSSWrapper"> <summary> Wrapper for the CSS object property </summary> </member> <member name="M:CMS.PortalEngine.CSSWrapper.#ctor(CMS.DataEngine.IInfoObjectCollection{CMS.DataEngine.BaseInfo},System.String)"> <summary> Constructor </summary> <param name="collection">Collection to wrap</param> <param name="propertyName">Property to extract</param> </member> <member name="M:CMS.PortalEngine.CSSWrapper.GetProperty(CMS.DataEngine.BaseInfo)"> <summary> Gets the property value for the given object </summary> <param name="obj">Obj from which to take the property</param> </member> <member name="M:CMS.PortalEngine.CSSWrapper.TrimCharset(System.String)"> <summary> Trims the charset from the CSS style </summary> <param name="data">CSS text where to trim the charset</param> </member> <member name="M:CMS.PortalEngine.CSSWrapper.GetObjectName(System.Object)"> <summary> Gets the object name for the given object </summary> <param name="obj">Object for which to get the name</param> </member> <member name="P:CMS.PortalEngine.CSSWrapper.ResolveMacrosInCSS"> <summary> If true, the macros are resolved within the CSS stylesheets </summary> </member> <member name="P:CMS.PortalEngine.CSSWrapper.ItemsHaveNames"> <summary> Returns true if the items in the collection have names </summary> </member> <member name="P:CMS.PortalEngine.CSSWrapper.SortNames"> <summary> If true, the names in enumeration are sorted </summary> </member> <member name="T:CMS.PortalEngine.CurrentComponentsList"> <summary> Current components used on the page </summary> </member> <member name="M:CMS.PortalEngine.CurrentComponentsList.RegisterWebPartContainer(CMS.PortalEngine.WebPartContainerInfo)"> <summary> Registers the web part container within the collection of containers for current request. </summary> <param name="container">Container object to register within current request</param> </member> <member name="M:CMS.PortalEngine.CurrentComponentsList.RegisterTransformation(CMS.PortalEngine.TransformationInfo)"> <summary> Registers the transformation within the collection of transformations for current request. </summary> <param name="transformation">Transformation object to register within current request</param> </member> <member name="M:CMS.PortalEngine.CurrentComponentsList.RegisterWebPartLayout(CMS.PortalEngine.WebPartLayoutInfo)"> <summary> Registers the web part layout within the collection of web part layouts for current request. </summary> <param name="webPartLayout">Web part layout object to register within current request</param> </member> <member name="M:CMS.PortalEngine.CurrentComponentsList.RegisterWebPart(CMS.PortalEngine.WebPartInfo)"> <summary> Registers the web part within the collection of web part s for current request. </summary> <param name="webPart">Web part object to register within current request</param> </member> <member name="M:CMS.PortalEngine.CurrentComponentsList.RegisterLayout(CMS.PortalEngine.LayoutInfo)"> <summary> Registers the layout within the collection of layouts for current request. </summary> <param name="layout">Layout object to register within current request</param> </member> <member name="M:CMS.PortalEngine.CurrentComponentsList.RegisterPageTemplate(CMS.PortalEngine.PageTemplateInfo)"> <summary> Registers the page template within the collection of page templates for current request. </summary> <param name="pageTemplate">Page template object to register within current request</param> </member> <member name="M:CMS.PortalEngine.CurrentComponentsList.RegisterDeviceLayout(CMS.PortalEngine.PageTemplateDeviceLayoutInfo)"> <summary> Registers the device layout within the collection of device layouts for current request. </summary> <param name="layout">Device layout object to register within current request</param> </member> <member name="P:CMS.PortalEngine.CurrentComponentsList.Containers"> <summary> Web part containers used by current page. Container name is used as a key. </summary> </member> <member name="P:CMS.PortalEngine.CurrentComponentsList.Transformations"> <summary> Transformations used by current page. Full name of the transformation is used as a key. </summary> </member> <member name="P:CMS.PortalEngine.CurrentComponentsList.WebPartLayouts"> <summary> Web part layouts used by current page. Full name of the web part layout is used as a key. </summary> </member> <member name="P:CMS.PortalEngine.CurrentComponentsList.WebParts"> <summary> Web parts used by current page. Web part name is used as a key. </summary> </member> <member name="P:CMS.PortalEngine.CurrentComponentsList.Layouts"> <summary> Layouts used by current page. Layout name is used as a key. </summary> </member> <member name="P:CMS.PortalEngine.CurrentComponentsList.Templates"> <summary> Page templates used by current page. Page template name is used as a key. </summary> </member> <member name="P:CMS.PortalEngine.CurrentComponentsList.DeviceLayouts"> <summary> Device layouts used by current page. Full name of the device layout is used as a key. </summary> </member> <member name="T:CMS.PortalEngine.DeviceLayoutVirtualFileObject"> <summary> Device layout virtual file object </summary> </member> <member name="M:CMS.PortalEngine.DeviceLayoutVirtualFileObject.#ctor(CMS.PortalEngine.PageTemplateDeviceLayoutInfo)"> <summary> Constructor </summary> <param name="currentObject">Object instance</param> </member> <member name="M:CMS.PortalEngine.DeviceLayoutVirtualFileObject.GetVirtualFileObject(System.String)"> <summary> Creates IVirtualFileObject for specified virtual path (GetVirtualFileObjectHandler callback method) </summary> <param name="virtualPath">Virtual path</param> </member> <member name="M:CMS.PortalEngine.DeviceLayoutVirtualFileObject.GetAdHocVirtualFileObject(System.String)"> <summary> Creates IVirtualFileObject for specified virtual path (GetVirtualFileObjectHandler callback method) </summary> <param name="virtualPath">Virtual path</param> </member> <member name="M:CMS.PortalEngine.DeviceLayoutVirtualFileObject.GetVirtualFileObjectInternal(System.String,System.Boolean)"> <summary> Creates IVirtualFileObject for specified virtual path (GetVirtualFileObjectHandler callback method) </summary> <param name="virtualPath">Virtual path</param> <param name="adHoc">Indicates whether page template is AdHoc</param> </member> <member name="P:CMS.PortalEngine.DeviceLayoutVirtualFileObject.Content"> <summary> Gets virtual file content for current object </summary> </member> <member name="P:CMS.PortalEngine.DeviceLayoutVirtualFileObject.IsStoredExternally"> <summary> Indicates whether file content is stored externally (e.g. file system) </summary> </member> <member name="P:CMS.PortalEngine.DeviceLayoutVirtualFileObject.ObjectHash"> <summary> Gets object hash string used for identification of compiled version in .NET cache </summary> </member> <member name="P:CMS.PortalEngine.DeviceLayoutVirtualFileObject.PhysicalFilePath"> <summary> Gets the physical file path if exists </summary> </member> <member name="P:CMS.PortalEngine.DeviceLayoutVirtualFileObject.CurrentObject"> <summary> Current object instance </summary> </member> <member name="T:CMS.PortalEngine.DeviceProfileLayoutInfo"> <summary> DeviceProfileLayoutInfo data container class. </summary> </member> <member name="F:CMS.PortalEngine.DeviceProfileLayoutInfo.OBJECT_TYPE"> <summary> Object type </summary> </member> <member name="F:CMS.PortalEngine.DeviceProfileLayoutInfo.TYPEINFO"> <summary> Type information. </summary> </member> <member name="M:CMS.PortalEngine.DeviceProfileLayoutInfo.DeleteObject"> <summary> Deletes the object using appropriate provider. </summary> </member> <member name="M:CMS.PortalEngine.DeviceProfileLayoutInfo.SetObject"> <summary> Updates the object using appropriate provider. </summary> </member> <member name="M:CMS.PortalEngine.DeviceProfileLayoutInfo.#ctor"> <summary> Constructor - Creates an empty DeviceProfileLayoutInfo object. </summary> </member> <member name="M:CMS.PortalEngine.DeviceProfileLayoutInfo.#ctor(System.Data.DataRow)"> <summary> Constructor - Creates a new DeviceProfileLayoutInfo object from the given DataRow. </summary> <param name="dr">DataRow with the object data.</param> </member> <member name="P:CMS.PortalEngine.DeviceProfileLayoutInfo.SourceLayoutID"> <summary> Source layout ID </summary> </member> <member name="P:CMS.PortalEngine.DeviceProfileLayoutInfo.DeviceProfileID"> <summary> Device profile ID </summary> </member> <member name="P:CMS.PortalEngine.DeviceProfileLayoutInfo.DeviceProfileLayoutGUID"> <summary> Device profile layout mapping GUID </summary> </member> <member name="P:CMS.PortalEngine.DeviceProfileLayoutInfo.DeviceProfileLayoutID"> <summary> Device profile layout mapping ID </summary> </member> <member name="P:CMS.PortalEngine.DeviceProfileLayoutInfo.TargetLayoutID"> <summary> Target layout ID </summary> </member> <member name="P:CMS.PortalEngine.DeviceProfileLayoutInfo.DeviceProfileLayoutLastModified"> <summary> Device profile layout mapping last modification timestamp </summary> </member> <member name="T:CMS.PortalEngine.DeviceProfileLayoutInfoProvider"> <summary> Provides DeviceProfileLayoutInfo object management. </summary> </member> <member name="F:CMS.PortalEngine.DeviceProfileLayoutInfoProvider.WebFarmTaskName_ClearTargetLayoutIdentifierHashtable"> <summary> A name of the ClearTargetLayoutIdentifierTable web farm task. </summary> </member> <member name="F:CMS.PortalEngine.DeviceProfileLayoutInfoProvider.mTargetLayoutIdentifiers"> <summary> A dictionary for caching of layout mappings. </summary> <remarks> The dictionary stores target layout identifiers using a composite key that consists of device and source layout identifiers. </remarks> </member> <member name="F:CMS.PortalEngine.DeviceProfileLayoutInfoProvider.mLock"> <summary> An internal object used for locking. </summary> </member> <member name="M:CMS.PortalEngine.DeviceProfileLayoutInfoProvider.GetDeviceProfileLayouts"> <summary> Returns all bindings between two layouts matching the specified parameters. </summary> </member> <member name="M:CMS.PortalEngine.DeviceProfileLayoutInfoProvider.GetDeviceProfileLayoutInfo(System.Int32)"> <summary> Returns a binding between two layouts with the specified identifier. </summary> <param name="bindingId">Binding identifier.</param> </member> <member name="M:CMS.PortalEngine.DeviceProfileLayoutInfoProvider.GetDeviceProfileLayoutInfo(System.Guid)"> <summary> Returns a binding between two layouts with the specified globally unique identifier. </summary> <param name="bindingGuid">Binding globally unique identifier.</param> </member> <member name="M:CMS.PortalEngine.DeviceProfileLayoutInfoProvider.SetDeviceProfileLayoutInfo(CMS.PortalEngine.DeviceProfileLayoutInfo)"> <summary> Sets (updates or inserts) the specified binding between two layouts. </summary> <param name="binding">The binding to set.</param> </member> <member name="M:CMS.PortalEngine.DeviceProfileLayoutInfoProvider.DeleteDeviceProfileLayoutInfo(CMS.PortalEngine.DeviceProfileLayoutInfo)"> <summary> Deletes the specified binding between two layouts. </summary> <param name="binding">The binding to delete.</param> </member> <member name="M:CMS.PortalEngine.DeviceProfileLayoutInfoProvider.DeleteDeviceProfileLayoutInfo(System.Int32)"> <summary> Deletes the specified binding between two layouts. </summary> <param name="bindingId">An identifier of the binding to delete.</param> </member> <member name="M:CMS.PortalEngine.DeviceProfileLayoutInfoProvider.GetTargetLayoutInfo(System.Int32,System.Int32)"> <summary> Returns a target layout for the specified device profile and source layout. </summary> <param name="deviceProfileId">Device profile identifier.</param> <param name="sourceLayoutId">Source layout identifier.</param> </member> <member name="M:CMS.PortalEngine.DeviceProfileLayoutInfoProvider.GetTargetLayoutInfo(CMS.DeviceProfiles.DeviceProfileInfo,CMS.PortalEngine.LayoutInfo)"> <summary> Returns a target layout for the specified device profile and source layout. </summary> <param name="deviceProfile">Device profile.</param> <param name="sourceLayout">Source layout.</param> </member> <member name="M:CMS.PortalEngine.DeviceProfileLayoutInfoProvider.GetTargetLayoutId(System.Int32,System.Int32)"> <summary> Returns a target layout identifier for the specified device profile and source layout. </summary> <param name="deviceProfileId">Device profile identifier.</param> <param name="sourceLayoutId">Source layout identifier.</param> </member> <member name="M:CMS.PortalEngine.DeviceProfileLayoutInfoProvider.GetTargetLayoutId(CMS.DeviceProfiles.DeviceProfileInfo,CMS.PortalEngine.LayoutInfo)"> <summary> Returns a target layout identifier for the specified device profile and source layout. </summary> <param name="deviceProfile">Device profile.</param> <param name="sourceLayout">Source layout.</param> </member> <member name="M:CMS.PortalEngine.DeviceProfileLayoutInfoProvider.GetDeviceProfileLayoutsInternal(System.String,System.String,System.Int32,System.String)"> <summary> Returns a dataset of all bindings between two layouts matching the specified parameters. </summary> <param name="where">Where condition.</param> <param name="orderBy">Order by expression.</param> <param name="topN">Number of records to be selected.</param> <param name="columns">Columns to be selected.</param> </member> <member name="M:CMS.PortalEngine.DeviceProfileLayoutInfoProvider.GetDeviceProfileLayoutInfoInternal(System.Int32)"> <summary> Returns a binding between two layouts with the specified identifier. </summary> <param name="bindingId">Binding identifier.</param> </member> <member name="M:CMS.PortalEngine.DeviceProfileLayoutInfoProvider.GetDeviceProfileLayoutInfoInternal(System.Guid)"> <summary> Returns a binding between two layouts with the specified globally unique identifier. </summary> <param name="bindingGuid">Binding globally unique identifier.</param> </member> <member name="M:CMS.PortalEngine.DeviceProfileLayoutInfoProvider.SetDeviceProfileLayoutInfoInternal(CMS.PortalEngine.DeviceProfileLayoutInfo)"> <summary> Sets (updates or inserts) the specified binding between two layouts. </summary> <param name="binding">The binding to set.</param> </member> <member name="M:CMS.PortalEngine.DeviceProfileLayoutInfoProvider.DeleteDeviceProfileLayoutInfoInternal(CMS.PortalEngine.DeviceProfileLayoutInfo)"> <summary> Deletes the specified binding between two layouts. </summary> <param name="binding">The binding to delete.</param> </member> <member name="M:CMS.PortalEngine.DeviceProfileLayoutInfoProvider.GetDeviceProfileLayoutsInternal"> <summary> Returns all bindings between two layouts matching the specified parameters. </summary> </member> <member name="M:CMS.PortalEngine.DeviceProfileLayoutInfoProvider.GetTargetLayoutIdInternal(System.Int32,System.Int32)"> <summary> Returns a target layout identifier for the specified device profile and source layout. </summary> <param name="deviceProfileId">Device profile identifier.</param> <param name="sourceLayoutId">Source layout identifier.</param> </member> <member name="M:CMS.PortalEngine.DeviceProfileLayoutInfoProvider.GetTargetLayoutCompositeKey(CMS.PortalEngine.DeviceProfileLayoutInfo)"> <summary> Creates a target layout composite key of the specified layout binding, and returns it. </summary> <param name="binding">A layout binding.</param> <returns>A composite key of the specified layout binding.</returns> </member> <member name="M:CMS.PortalEngine.DeviceProfileLayoutInfoProvider.GetTargetLayoutCompositeKey(System.Int32,System.Int32)"> <summary> Creates a target layout composite key of the specified layout binding, and returns it. </summary> <param name="deviceProfileId">A device profile identifier.</param> <param name="sourceLayoutId">A source layout identifier.</param> <returns>A composite key of the specified layout binding.</returns> </member> <member name="M:CMS.PortalEngine.DeviceProfileLayoutInfoProvider.ProcessWebFarmTask(System.String,System.String,System.Byte[])"> <summary> Runs this provider's web farm tasks. </summary> <param name="actionName">An action name.</param> <param name="data">Custom task data.</param> <param name="binary">Binary data.</param> </member> <member name="M:CMS.PortalEngine.DeviceProfileLayoutInfoProvider.ClearHashtables(System.Boolean)"> <summary> Clear hashtables. </summary> <param name="logTasks">If true, web farm tasks are logged</param> </member> <member name="M:CMS.PortalEngine.DeviceProfileLayoutInfoProvider.Clear(System.Boolean)"> <summary> Clears provider's cache. </summary> <param name="logTasks">Indicates whether web farm tasks will be created.</param> </member> <member name="M:CMS.PortalEngine.DeviceProfileLayoutInfoProvider.ClearTargetLayoutIdentifierHashtable(System.Boolean)"> <summary> Clears provider's cache of target layouts based on device profile and source layout. </summary> <param name="logTasks">Indicates whether web farm tasks will be created.</param> </member> <member name="M:CMS.PortalEngine.DeviceProfileLayoutInfoProvider.CreateClearTargetLayoutIdentifierHashtableWebFarmTask"> <summary> Creates a web farm task to clear a cache of target layouts based on device profile and source layout. </summary> </member> <member name="P:CMS.PortalEngine.DeviceProfileLayoutInfoProvider.TargetLayoutIdentifiers"> <summary> Gets or sets a dictionary for caching of layout mappings. </summary> </member> <member name="T:CMS.PortalEngine.EditModeButtonEnum"> <summary> Enumeration of the available edit mode buttons </summary> </member> <member name="F:CMS.PortalEngine.EditModeButtonEnum.None"> <summary> None </summary> </member> <member name="F:CMS.PortalEngine.EditModeButtonEnum.Both"> <summary> Both </summary> </member> <member name="F:CMS.PortalEngine.EditModeButtonEnum.Edit"> <summary> Edit line </summary> </member> <member name="F:CMS.PortalEngine.EditModeButtonEnum.Delete"> <summary> Delete line </summary> </member> <member name="T:CMS.PortalEngine.DeleteWidgetVariantsHandler"> <summary> Delete widget variants handler </summary> </member> <member name="T:CMS.PortalEngine.GetVariantEventArgs"> <summary> Argument class for event raised when variant is requested. </summary> </member> <member name="P:CMS.PortalEngine.GetVariantEventArgs.PageTemplateID"> <summary> Current page template ID </summary> </member> <member name="P:CMS.PortalEngine.GetVariantEventArgs.VariantType"> <summary> Type of variant event is using. </summary> </member> <member name="P:CMS.PortalEngine.GetVariantEventArgs.VariantName"> <summary> Name of the variant to find.s </summary> </member> <member name="P:CMS.PortalEngine.GetVariantEventArgs.VariantID"> <summary> ID of return variant </summary> </member> <member name="P:CMS.PortalEngine.GetVariantEventArgs.DocumentIdIsNull"> <summary> If set, adds check to SQL query whether the variant document id is or is not null. When null, skips the check. </summary> </member> <member name="T:CMS.PortalEngine.GetVariantHandler"> <summary> Get variant handler </summary> </member> <member name="T:CMS.PortalEngine.GetVariantsHandler"> <summary> Get variants handler </summary> </member> <member name="T:CMS.PortalEngine.MVTVariantsEnabledHandler"> <summary> MVT variants enabled handler </summary> </member> <member name="T:CMS.PortalEngine.PortalEngineEventArgs"> <summary> Event arguments for portal engine </summary> </member> <member name="P:CMS.PortalEngine.PortalEngineEventArgs.Enabled"> <summary> State of request </summary> </member> <member name="P:CMS.PortalEngine.PortalEngineEventArgs.Zone"> <summary> Zone instance </summary> </member> <member name="T:CMS.PortalEngine.PortalEngineEvents"> <summary> Events for portal engine </summary> </member> <member name="F:CMS.PortalEngine.PortalEngineEvents.MVTVariantsEnabled"> <summary> Fired when request for availability of variants is raised </summary> </member> <member name="F:CMS.PortalEngine.PortalEngineEvents.GetVariants"> <summary> Fired when request for variants collection is raised. </summary> </member> <member name="F:CMS.PortalEngine.PortalEngineEvents.GetVariant"> <summary> Fired when request for single variant is raised. </summary> </member> <member name="F:CMS.PortalEngine.PortalEngineEvents.SetVariantWebParts"> <summary> Fired when variant is to be saved. </summary> </member> <member name="F:CMS.PortalEngine.PortalEngineEvents.SetVariant"> <summary> Fired when variant's properties are to be saved. </summary> </member> <member name="F:CMS.PortalEngine.PortalEngineEvents.DeleteWidgetVariants"> <summary> Fired when variants are to be reseted. </summary> </member> <member name="T:CMS.PortalEngine.DeleteVariantEventArgs"> <summary> Argument class for deleting variants </summary> </member> <member name="P:CMS.PortalEngine.DeleteVariantEventArgs.ZoneID"> <summary> ID of variant's zone </summary> </member> <member name="P:CMS.PortalEngine.DeleteVariantEventArgs.PageTemplateID"> <summary> ID of variant's page template </summary> </member> <member name="P:CMS.PortalEngine.DeleteVariantEventArgs.DocumentID"> <summary> ID of variant's document </summary> </member> <member name="T:CMS.PortalEngine.SetVariantEventArgs"> <summary> Class used for handling saving variants </summary> </member> <member name="P:CMS.PortalEngine.SetVariantEventArgs.VariantID"> <summary> Varaint's (zone or webpart) ID </summary> </member> <member name="P:CMS.PortalEngine.SetVariantEventArgs.XmlDefinition"> <summary> XML node (webpart or zone) definition </summary> </member> <member name="P:CMS.PortalEngine.SetVariantEventArgs.VariantType"> <summary> Type of variant event is using. </summary> </member> <member name="P:CMS.PortalEngine.SetVariantEventArgs.Variant"> <summary> Settings object with variant information. </summary> </member> <member name="T:CMS.PortalEngine.SetVariantHandler"> <summary> Set variant handler </summary> </member> <member name="T:CMS.PortalEngine.PageTemplateCloneEventArgs"> <summary> Arguments for the template cloning handler. </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateCloneEventArgs.OriginalPageTemplate"> <summary> Original (the one which is being cloned) page template. </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateCloneEventArgs.NewPageTemplate"> <summary> Newly created template (a clone). </summary> </member> <member name="T:CMS.PortalEngine.PageTemplateCloneHandler"> <summary> Handler for the template cloning. </summary> </member> <member name="M:CMS.PortalEngine.PageTemplateCloneHandler.StartEvent(CMS.PortalEngine.PageTemplateInfo)"> <summary> Initiates event handling. </summary> <param name="originalPageTemplate">Original (the one which is being cloned) page template</param> <returns>Event handler</returns> </member> <member name="T:CMS.PortalEngine.GetVariantsEventArgs"> <summary> Variants handling event arguments </summary> </member> <member name="P:CMS.PortalEngine.GetVariantsEventArgs.ZoneID"> <summary> Variant's zone ID </summary> </member> <member name="P:CMS.PortalEngine.GetVariantsEventArgs.PageTemplateID"> <summary> Current page template ID </summary> </member> <member name="P:CMS.PortalEngine.GetVariantsEventArgs.VariantType"> <summary> Type of variant event is using. </summary> </member> <member name="P:CMS.PortalEngine.GetVariantsEventArgs.Variants"> <summary> Data set with loaded variants. </summary> </member> <member name="P:CMS.PortalEngine.GetVariantsEventArgs.InstanceGuid"> <summary> Instance guid </summary> </member> <member name="P:CMS.PortalEngine.GetVariantsEventArgs.DocumentID"> <summary> Document ID related to variants (widgets) </summary> </member> <member name="T:CMS.PortalEngine.MoveWebPartHandler"> <summary> Move web part handler </summary> </member> <member name="T:CMS.PortalEngine.ChangeLayoutZoneIdHandler"> <summary> Handler which is used when the layout zone id is changed. </summary> </member> <member name="T:CMS.PortalEngine.RemoveWebPartHandler"> <summary> Remove web part handler </summary> </member> <member name="T:CMS.PortalEngine.WebPartLoadVariantsArgs"> <summary> Argument class for events raised for load variants. </summary> </member> <member name="P:CMS.PortalEngine.WebPartLoadVariantsArgs.ForceLoad"> <summary> Indicates whether load should be raised at all cases </summary> </member> <member name="P:CMS.PortalEngine.WebPartLoadVariantsArgs.VariantMode"> <summary> Variant mode </summary> </member> <member name="P:CMS.PortalEngine.WebPartLoadVariantsArgs.WebPartInstance"> <summary> Instance for variants' webpart </summary> </member> <member name="P:CMS.PortalEngine.WebPartLoadVariantsArgs.WebPartZoneInstance"> <summary> Instance for variants' zone </summary> </member> <member name="P:CMS.PortalEngine.WebPartLoadVariantsArgs.DocumentID"> <summary> Gets the document ID if the instance holds a widget </summary> </member> <member name="T:CMS.PortalEngine.MoveWebPartsArgs"> <summary> Argument class for events raised after web part movement. </summary> </member> <member name="P:CMS.PortalEngine.MoveWebPartsArgs.Zone"> <summary> Source zone instance </summary> </member> <member name="P:CMS.PortalEngine.MoveWebPartsArgs.TargetZone"> <summary> Target zone instance </summary> </member> <member name="P:CMS.PortalEngine.MoveWebPartsArgs.TemplateInfo"> <summary> Template info object </summary> </member> <member name="P:CMS.PortalEngine.MoveWebPartsArgs.WebPartInstance"> <summary> Instance of copied webpart </summary> </member> <member name="T:CMS.PortalEngine.RemoveWebPartsArgs"> <summary> Argument class for events raised after webpart is removed </summary> </member> <member name="P:CMS.PortalEngine.RemoveWebPartsArgs.WebPartInstance"> <summary> Removed webpart instance </summary> </member> <member name="P:CMS.PortalEngine.RemoveWebPartsArgs.Zone"> <summary> Source zone instance </summary> </member> <member name="T:CMS.PortalEngine.ChangeLayoutZoneIdArgs"> <summary> Argument class for events raised for layout zone id change. </summary> </member> <member name="P:CMS.PortalEngine.ChangeLayoutZoneIdArgs.OldZoneId"> <summary> Gets or sets the old layout zone id. </summary> </member> <member name="P:CMS.PortalEngine.ChangeLayoutZoneIdArgs.NewZoneId"> <summary> Gets or sets the new layout zone id. </summary> </member> <member name="P:CMS.PortalEngine.ChangeLayoutZoneIdArgs.PageTemplateId"> <summary> Gets or sets the page template id where the layout zone is located. </summary> </member> <member name="P:CMS.PortalEngine.ChangeLayoutZoneIdArgs.ZoneWebParts"> <summary> Gets or sets the layout zone web parts. </summary> </member> <member name="T:CMS.PortalEngine.WebPartEvents"> <summary> Web part (web part zone) events </summary> </member> <member name="F:CMS.PortalEngine.WebPartEvents.WebPartZoneLoadVariant"> <summary> Fires when web parts load variants </summary> </member> <member name="F:CMS.PortalEngine.WebPartEvents.WebPartLoadVariant"> <summary> Fires when web parts load variants </summary> </member> <member name="F:CMS.PortalEngine.WebPartEvents.MoveWebPart"> <summary> Fires when single web part is moved </summary> </member> <member name="F:CMS.PortalEngine.WebPartEvents.MoveAllWebParts"> <summary> Fires when all web parts are moved </summary> </member> <member name="F:CMS.PortalEngine.WebPartEvents.RemoveWebPart"> <summary> Fires when web part is removed </summary> </member> <member name="F:CMS.PortalEngine.WebPartEvents.RemoveAllWebParts"> <summary> Fires when all web part are removed </summary> </member> <member name="F:CMS.PortalEngine.WebPartEvents.ChangeLayoutZoneId"> <summary> Fires when a layout zone id is changed </summary> </member> <member name="T:CMS.PortalEngine.WebPartLoadVariantHandler"> <summary> Web part load variant handler </summary> </member> <member name="T:CMS.PortalEngine.InlineControlInfo"> <summary> InlineControlInfo data container class. </summary> </member> <member name="F:CMS.PortalEngine.InlineControlInfo.OBJECT_TYPE"> <summary> Object type </summary> </member> <member name="F:CMS.PortalEngine.InlineControlInfo.TYPEINFO"> <summary> Type information. </summary> </member> <member name="M:CMS.PortalEngine.InlineControlInfo.DeleteObject"> <summary> Deletes the object using appropriate provider. </summary> </member> <member name="M:CMS.PortalEngine.InlineControlInfo.SetObject"> <summary> Updates the object using appropriate provider. </summary> </member> <member name="M:CMS.PortalEngine.InlineControlInfo.#ctor"> <summary> Constructor - Creates an empty InlineControlInfo object. </summary> </member> <member name="M:CMS.PortalEngine.InlineControlInfo.#ctor(System.Data.DataRow)"> <summary> Constructor - Creates a new InlineControlInfo object from the given DataRow. </summary> </member> <member name="M:CMS.PortalEngine.InlineControlInfo.InsertAsCloneInternal(CMS.DataEngine.CloneSettings,CMS.DataEngine.CloneResult,CMS.DataEngine.BaseInfo)"> <summary> Inserts cloned object to DB. </summary> <param name="settings">Cloning settings</param> <param name="result">Cloning result</param> <param name="originalObject">Original source BaseInfo (object being cloned)</param> </member> <member name="P:CMS.PortalEngine.InlineControlInfo.ControlDescription"> <summary> Control description. </summary> </member> <member name="P:CMS.PortalEngine.InlineControlInfo.ControlDisplayName"> <summary> Control display name. </summary> </member> <member name="P:CMS.PortalEngine.InlineControlInfo.ControlID"> <summary> Control ID. </summary> </member> <member name="P:CMS.PortalEngine.InlineControlInfo.ControlName"> <summary> Control name. </summary> </member> <member name="P:CMS.PortalEngine.InlineControlInfo.ControlFileName"> <summary> Control file name (for system purposes). </summary> </member> <member name="P:CMS.PortalEngine.InlineControlInfo.ControlGUID"> <summary> Control GUID. </summary> </member> <member name="P:CMS.PortalEngine.InlineControlInfo.ControlLastModified"> <summary> Object last modified. </summary> </member> <member name="P:CMS.PortalEngine.InlineControlInfo.ControlResourceID"> <summary> Control resource (module) ID. </summary> </member> <member name="T:CMS.PortalEngine.InlineControlInfoProvider"> <summary> Class providing InlineControlInfo management. </summary> </member> <member name="F:CMS.PortalEngine.InlineControlInfoProvider.mInlineControlsDirectory"> <summary> Inline controls directory. </summary> </member> <member name="M:CMS.PortalEngine.InlineControlInfoProvider.#ctor"> <summary> Constructor </summary> </member> <member name="M:CMS.PortalEngine.InlineControlInfoProvider.GetInlineControlInfoByGUID(System.Guid)"> <summary> Returns object with specified GUID. </summary> <param name="guid">Object GUID</param> </member> <member name="M:CMS.PortalEngine.InlineControlInfoProvider.GetInlineControlInfo(System.Int32)"> <summary> Returns the InlineControlInfo structure for the specified inlineControl. </summary> <param name="inlineControlId">InlineControl id</param> </member> <member name="M:CMS.PortalEngine.InlineControlInfoProvider.GetInlineControlInfo(System.String)"> <summary> Returns the InlineControlInfo structure for the specified inlineControl. </summary> <param name="controlName">InlineControl name</param> </member> <member name="M:CMS.PortalEngine.InlineControlInfoProvider.SetInlineControlInfo(CMS.PortalEngine.InlineControlInfo)"> <summary> Sets (updates or inserts) specified inlineControl. </summary> <param name="inlineControl">InlineControl to set</param> </member> <member name="M:CMS.PortalEngine.InlineControlInfoProvider.DeleteInlineControlInfo(CMS.PortalEngine.InlineControlInfo)"> <summary> Deletes specified inlineControl. </summary> <param name="inlineControlObj">InlineControl object</param> </member> <member name="M:CMS.PortalEngine.InlineControlInfoProvider.DeleteInlineControlInfo(System.Int32)"> <summary> Deletes specified inlineControl. </summary> <param name="inlineControlId">InlineControl id</param> </member> <member name="M:CMS.PortalEngine.InlineControlInfoProvider.GetInlineControlsForSite(System.Int32)"> <summary> Returns the dataset containing the inline controls for the specified site. </summary> <param name="siteID">Site id</param> </member> <member name="M:CMS.PortalEngine.InlineControlInfoProvider.GetInlineControlsForSite(System.Int32,System.String)"> <summary> Returns the dataset containing the inline controls for the specified site. </summary> <param name="siteID">Site id</param> <param name="columns">Selected columns</param> </member> <member name="M:CMS.PortalEngine.InlineControlInfoProvider.GetInlineControls"> <summary> Returns all in-line controls. </summary> </member> <member name="M:CMS.PortalEngine.InlineControlInfoProvider.GetInlineControlUrl(System.String)"> <summary> Returns virtual path to the inline control file. </summary> <param name="controlName">Inline control name</param> </member> <member name="M:CMS.PortalEngine.InlineControlInfoProvider.GetInlineControlUrl(CMS.PortalEngine.InlineControlInfo)"> <summary> Returns virtual path to the inline control file. </summary> <param name="controlInfo">Inline control info object</param> </member> <member name="M:CMS.PortalEngine.InlineControlInfoProvider.GetFullPhysicalPath(CMS.PortalEngine.InlineControlInfo)"> <summary> Returns full path of the inline control. </summary> <param name="controlInfo">Inline control info object</param> </member> <member name="M:CMS.PortalEngine.InlineControlInfoProvider.GetFullPhysicalPath(CMS.PortalEngine.InlineControlInfo,System.String)"> <summary> Returns full path of the inline control. </summary> <param name="controlInfo">Inline control info object</param> <param name="webFullPath">Full path to the root of the web project (e.g. c:\WebProject\)</param> </member> <member name="M:CMS.PortalEngine.InlineControlInfoProvider.GetInlineControlsInternal"> <summary> Returns all in-line controls. </summary> </member> <member name="M:CMS.PortalEngine.InlineControlInfoProvider.GetInlineControlInfoByGUIDInternal(System.Guid)"> <summary> Returns object with specified GUID. </summary> <param name="guid">Object GUID</param> </member> <member name="M:CMS.PortalEngine.InlineControlInfoProvider.GetInlineControlInfoInternal(System.Int32)"> <summary> Returns the InlineControlInfo structure for the specified inlineControl. </summary> <param name="inlineControlId">InlineControl id</param> </member> <member name="M:CMS.PortalEngine.InlineControlInfoProvider.GetInlineControlInfoInternal(System.String)"> <summary> Returns the InlineControlInfo structure for the specified inlineControl. </summary> <param name="controlName">InlineControl name</param> </member> <member name="M:CMS.PortalEngine.InlineControlInfoProvider.SetInlineControlInfoInternal(CMS.PortalEngine.InlineControlInfo)"> <summary> Sets (updates or inserts) specified inlineControl. </summary> <param name="inlineControl">InlineControl to set</param> </member> <member name="M:CMS.PortalEngine.InlineControlInfoProvider.DeleteInlineControlInfoInternal(CMS.PortalEngine.InlineControlInfo)"> <summary> Deletes specified inlineControl. </summary> <param name="inlineControlObj">InlineControl object</param> </member> <member name="M:CMS.PortalEngine.InlineControlInfoProvider.GetInlineControlsForSiteInternal(System.Int32,System.String)"> <summary> Returns the dataset containing the inline controls for the specified site. </summary> <param name="siteID">Site id</param> <param name="columns">Selected columns</param> </member> <member name="P:CMS.PortalEngine.InlineControlInfoProvider.InlineControlsDirectory"> <summary> Inline controls directory. </summary> </member> <member name="T:CMS.PortalEngine.EditableItems"> <summary> Editable items container. </summary> </member> <member name="M:CMS.PortalEngine.EditableItems.GetFirstKey(System.String)"> <summary> Gets the first key from the key list defined as string with ';' as separator. </summary> <param name="key">Key</param> </member> <member name="M:CMS.PortalEngine.EditableItems.LoadFromXmlElement(System.Xml.XmlElement)"> <summary> Loads the data from the given XML element </summary> <param name="element">XML element</param> </member> <member name="M:CMS.PortalEngine.EditableItems.GetXmlElement(System.Xml.XmlDocument)"> <summary> Gets the XML element for the data </summary> <param name="doc">Parent XML document</param> </member> <member name="M:CMS.PortalEngine.EditableItems.LoadContentXml(System.String)"> <summary> Loads the content XML to the content table. </summary> <param name="contentXml">Content XML to load</param> </member> <member name="M:CMS.PortalEngine.EditableItems.LoadEditableItems(CMS.Base.MultiKeyDictionary{System.String},System.Xml.XmlElement,System.String)"> <summary> Fills editable items dictionary from xml document for specific element </summary> <param name="items">Items collection</param> <param name="xmlElement">Source Xml element</param> <param name="elementName">Element name</param> </member> <member name="M:CMS.PortalEngine.EditableItems.GetContentXml"> <summary> Returns the xml code of the document contents (Editable regions, web parts). </summary> </member> <member name="M:CMS.PortalEngine.EditableItems.SetItemsXml(CMS.Base.MultiKeyDictionary{System.String},System.Xml.XmlDocument,System.String)"> <summary> Sets the items to the xml document under the specific node defined by element name </summary> <param name="items">Editable items list</param> <param name="xml">XML document</param> <param name="elementName">Xml element name</param> </member> <member name="M:CMS.PortalEngine.EditableItems.Clone"> <summary> Returns the cloned object. </summary> </member> <member name="M:CMS.PortalEngine.EditableItems.GetValue(System.String)"> <summary> Gets the value of specific field. </summary> <param name="columnName">Column name</param> </member> <member name="M:CMS.PortalEngine.EditableItems.SetValue(System.String,System.Object)"> <summary> Sets the value of specific field. </summary> <param name="columnName">Column name</param> <param name="value">New value</param> </member> <member name="M:CMS.PortalEngine.EditableItems.TryGetValue(System.String,System.Object@)"> <summary> Tries to get the value of specific column. </summary> <param name="columnName">Column name</param> <param name="value">Returns value</param> </member> <member name="M:CMS.PortalEngine.EditableItems.ContainsColumn(System.String)"> <summary> Returns true if the structure contains specific column. </summary> <param name="columnName">Column name</param> </member> <member name="P:CMS.PortalEngine.EditableItems.EditableRegions"> <summary> Editable regions contained within the document. </summary> </member> <member name="P:CMS.PortalEngine.EditableItems.EditableWebParts"> <summary> Editable WebParts contained within the document. </summary> </member> <member name="P:CMS.PortalEngine.EditableItems.Item(System.String)"> <summary> Returns the editable value. </summary> <param name="controlId">Control ID</param> </member> <member name="P:CMS.PortalEngine.EditableItems.CMS#Base#ISimpleDataContainer#Item(System.String)"> <summary> Gets or sets the field value. </summary> <param name="columnName">Column name</param> </member> <member name="P:CMS.PortalEngine.EditableItems.ColumnNames"> <summary> Returns the available column names. </summary> </member> <member name="T:CMS.PortalEngine.PageTemplateInstance"> <summary> Class holding the page template structure information. </summary> </member> <member name="F:CMS.PortalEngine.PageTemplateInstance.mWebPartZones"> <summary> Collection of the webpart zones contained within the page template. </summary> </member> <member name="F:CMS.PortalEngine.PageTemplateInstance.mWebPartsXml"> <summary> Web parts XML. </summary> </member> <member name="M:CMS.PortalEngine.PageTemplateInstance.#ctor"> <summary> Empty constructor </summary> </member> <member name="M:CMS.PortalEngine.PageTemplateInstance.#ctor(System.String)"> <summary> Constructor </summary> <param name="webPartsXml">Web parts XML</param> </member> <member name="M:CMS.PortalEngine.PageTemplateInstance.LoadFromXmlElement(System.Xml.XmlElement)"> <summary> Loads the data from the given XML element </summary> <param name="element">XML element</param> </member> <member name="M:CMS.PortalEngine.PageTemplateInstance.LoadFromXml(System.String)"> <summary> Reloads the zones and webparts info. </summary> <param name="webPartsXml">Web parts XML</param> </member> <member name="M:CMS.PortalEngine.PageTemplateInstance.LoadVariants(System.Boolean,CMS.PortalEngine.VariantModeEnum)"> <summary> Loads all the MVT/Content personalization variants for this template instance. </summary> <param name="forceLoad">Indicates if already loaded variants should be reloaded</param> <param name="variantMode">Specifies which variants should be loaded (MVT/ContentPersonalization/None - means both MVT+CP variants should try to load)</param> </member> <member name="M:CMS.PortalEngine.PageTemplateInstance.GetXmlElement(System.Xml.XmlDocument)"> <summary> Gets the XML element for the data </summary> <param name="doc">Parent XML document</param> </member> <member name="M:CMS.PortalEngine.PageTemplateInstance.GetXmlElement(System.Xml.XmlDocument,CMS.PortalEngine.WidgetZoneTypeEnum)"> <summary> Gets the XML element for the data </summary> <param name="doc">Parent XML document</param> <param name="zoneType">Zone type to output</param> </member> <member name="M:CMS.PortalEngine.PageTemplateInstance.GetZonesXML(CMS.PortalEngine.WidgetZoneTypeEnum)"> <summary> Returns the XML representation of the zones configuration. </summary> <param name="zoneType">Zone type to get</param> </member> <member name="M:CMS.PortalEngine.PageTemplateInstance.ContainsZones(CMS.PortalEngine.WidgetZoneTypeEnum)"> <summary> Returns true if the page template contains zones of the specific type. </summary> <param name="zoneType">Zone type</param> </member> <member name="M:CMS.PortalEngine.PageTemplateInstance.CombineWith(CMS.PortalEngine.PageTemplateInstance,CMS.PortalEngine.WidgetZoneTypeEnum,System.Boolean)"> <summary> Combines two page template instances, applies the other page template instance settings (only those matching the required zone type in the current instance) to the current instance. Does not add new zones which are not present in the current instance. </summary> <param name="pti">Page template instance with the personalization</param> <param name="zoneType">Zone type to overwrite</param> <param name="keepZoneProperties">If true, the original zone properties are kept</param> </member> <member name="M:CMS.PortalEngine.PageTemplateInstance.CombineWith(CMS.PortalEngine.WebPartInstance)"> <summary> Combines the page template instance with a web part instance, applies the web part instance settings to the current page template instance. </summary> <param name="wpi">The wpi</param> </member> <member name="M:CMS.PortalEngine.PageTemplateInstance.CombineWith(CMS.PortalEngine.WebPartZoneInstance)"> <summary> Combines the page template instance with a web part zone instance, applies the web part zone instance settings to the current page template instance. </summary> <param name="wpzi">Web part zone instance</param> </member> <member name="M:CMS.PortalEngine.PageTemplateInstance.Clone(System.Boolean,System.Boolean)"> <summary> Clones the instance of page templates. </summary> <param name="cloneZones">If true, the zone instances are cloned</param> <param name="copyMacroTable">Indicates whether macro values should be cloned</param> </member> <member name="M:CMS.PortalEngine.PageTemplateInstance.UpdateParentTemplateInstance(CMS.PortalEngine.WebPartZoneInstance,CMS.PortalEngine.PageTemplateInstance)"> <summary> Sets <see cref="P:CMS.PortalEngine.WebPartZoneInstance.ParentTemplateInstance"/> property of given <paramref name="zoneInstance"/> and all its zone variants to specified <paramref name="templateInstance"/>. </summary> <param name="zoneInstance">Web part zone instance to be updated</param> <param name="templateInstance">Target page template instance</param> </member> <member name="M:CMS.PortalEngine.PageTemplateInstance.GetZone(System.String,System.Int32)"> <summary> Returns the zone instance with specified ID or null when not found. </summary> <param name="zoneId">Zone ID to find</param> <param name="zoneVariantId">The zone variant id</param> </member> <member name="M:CMS.PortalEngine.PageTemplateInstance.EnsureZone(System.String)"> <summary> Ensures that the instance of the given zone exists. </summary> <param name="zoneId">Zone ID to ensure</param> </member> <member name="M:CMS.PortalEngine.PageTemplateInstance.AddZone(CMS.PortalEngine.WebPartZoneInstance)"> <summary> Adds the given zone to the template </summary> <param name="zone">Zone to add</param> <remarks>Returns a new instance of web part zone if the given zone is present within it's parent zone</remarks> </member> <member name="M:CMS.PortalEngine.PageTemplateInstance.ZoneExists(System.String)"> <summary> Returns true if zone with given ID already exists </summary> <param name="zoneId">Zone ID to check</param> </member> <member name="M:CMS.PortalEngine.PageTemplateInstance.AddWebPart(System.String,CMS.PortalEngine.WebPartInstance,System.Int32)"> <summary> Adds the web part instance to the specified zone. </summary> <param name="zoneId">Zone ID</param> <param name="webPart">Web part</param> <param name="position">Position index</param> <remarks>Returns a new instance of web part if the given web part is present within it's parent zone</remarks> </member> <member name="M:CMS.PortalEngine.PageTemplateInstance.AddWebPart(System.String,System.Int32,System.Int32)"> <summary> Adds the web part instance to the specified zone </summary> <param name="zoneId">Zone ID</param> <param name="webPartId">Web part ID</param> <param name="position">The position of the web part in the target zone</param> </member> <member name="M:CMS.PortalEngine.PageTemplateInstance.AddWidget(System.String,System.Int32)"> <summary> Adds the widget instance to the specified zone. </summary> <param name="zoneId">Zone ID</param> <param name="widgetId">Web part ID</param> </member> <member name="M:CMS.PortalEngine.PageTemplateInstance.RemoveZone(CMS.PortalEngine.WebPartZoneInstance)"> <summary> Removes zone from template instance </summary> <param name="zone">Zone instance to remove</param> </member> <member name="M:CMS.PortalEngine.PageTemplateInstance.RemoveNestedZones(CMS.PortalEngine.WebPartInstance)"> <summary> Removes the nested zones for the given web part </summary> <param name="webPart">Web part for which the nested zones will be removed</param> </member> <member name="M:CMS.PortalEngine.PageTemplateInstance.GetNestedZones(System.String)"> <summary> Gets the list of zones nested in the given web part </summary> <param name="webPartId">Web part ID</param> </member> <member name="M:CMS.PortalEngine.PageTemplateInstance.MoveWebPart(CMS.PortalEngine.WebPartInstance,CMS.PortalEngine.WebPartZoneInstance,CMS.PortalEngine.WebPartZoneInstance,System.String,System.Int32)"> <summary> Moves the web part between two zones </summary> <param name="webPart">Web part to move</param> <param name="sourceZoneInstance">Source zone</param> <param name="targetZoneInstance">Target zone instance</param> <param name="targetPosition">Target position</param> <param name="targetZoneId">Target zone ID</param> </member> <member name="M:CMS.PortalEngine.PageTemplateInstance.CannotMoveWebPart(CMS.PortalEngine.WebPartInstance)"> <summary> Throws the exception that the web part cannot be moved to it's own nested zone </summary> <param name="wpi">Web part instance</param> <exception cref="T:System.InvalidOperationException">Thrown in all cases</exception> </member> <member name="M:CMS.PortalEngine.PageTemplateInstance.MoveAllWebParts(CMS.PortalEngine.WebPartZoneInstance,CMS.PortalEngine.WebPartZoneInstance)"> <summary> Moves all web parts from one zone to another </summary> <param name="zone">Source zone</param> <param name="targetZone">Target zone</param> </member> <member name="M:CMS.PortalEngine.PageTemplateInstance.MoveWebPartUp(CMS.PortalEngine.WebPartInstance,System.Boolean)"> <summary> Moves web part up within its zone. </summary> <param name="webPart">Web part</param> <param name="top">If true, the web part is moved to the top</param> </member> <member name="M:CMS.PortalEngine.PageTemplateInstance.MoveWebPartUp(System.String,System.String,System.Boolean)"> <summary> Moves web part up within the instance of the specified zone. </summary> <param name="zoneId">Zone ID</param> <param name="webPartControlId">Web part ID</param> <param name="top">If true, the web part is moved to the bottom</param> </member> <member name="M:CMS.PortalEngine.PageTemplateInstance.MoveWebPartDown(CMS.PortalEngine.WebPartInstance,System.Boolean)"> <summary> Moves web part down within its zone. </summary> <param name="webPart">Web part</param> <param name="bottom">If true, the web part is moved to the bottom</param> </member> <member name="M:CMS.PortalEngine.PageTemplateInstance.MoveWebPartDown(System.String,System.String,System.Boolean)"> <summary> Moves web part down within the instance of the specified zone. </summary> <param name="zoneId">Zone ID</param> <param name="webPartControlId">Web part ID</param> <param name="bottom">If true, the web part is moved to the bottom</param> </member> <member name="M:CMS.PortalEngine.PageTemplateInstance.MoveWebPartToPreviousZone(CMS.PortalEngine.WebPartInstance)"> <summary> Moves the web part to the previous zone. </summary> <param name="webPart">Web part</param> </member> <member name="M:CMS.PortalEngine.PageTemplateInstance.MoveWebPartToPreviousZone(System.String,System.String)"> <summary> Moves the web part to the previous zone. </summary> <param name="zoneId">Current web part zone ID</param> <param name="webPartControlId">Web part control ID</param> </member> <member name="M:CMS.PortalEngine.PageTemplateInstance.MoveWebPartToNextZone(CMS.PortalEngine.WebPartInstance)"> <summary> Moves the web part to the Next zone. </summary> <param name="webPart">Web part</param> </member> <member name="M:CMS.PortalEngine.PageTemplateInstance.MoveWebPartToNextZone(System.String,System.String)"> <summary> Moves the web part to the next zone. </summary> <param name="zoneId">Current web part zone ID</param> <param name="webPartControlId">Web part control ID</param> </member> <member name="M:CMS.PortalEngine.PageTemplateInstance.CloneWebPart(CMS.PortalEngine.WebPartInstance)"> <summary> Clones the web part. </summary> <param name="webPart">Web part</param> </member> <member name="M:CMS.PortalEngine.PageTemplateInstance.GetWebPart(System.String,System.Boolean)"> <summary> Returns the web part with specified ID or null if not found. </summary> <param name="webPartControlId">Web part control ID to retrieve</param> <param name="searchInVariants">Indicates whether to search in the zone variants as well.</param> </member> <member name="M:CMS.PortalEngine.PageTemplateInstance.GetWebPart(System.Guid,System.String)"> <summary> Returns the web part with specified GUID or ID or null if not found. </summary> <param name="webPartGuid">Web part GUID</param> <param name="webPartControlId">Web part control ID to retrieve</param> </member> <member name="M:CMS.PortalEngine.PageTemplateInstance.GetWebPart(System.Guid,System.Int32,System.Int32)"> <summary> Finds the web part by its GUID. </summary> <param name="instanceGuid">Web part instance GUID</param> <param name="zoneVariantId">The zone variant id. 1..: search just in the specific zone variant 0: search only in the original zones -1: search in all zones and their variants</param> <param name="webPartVariantId">The web part variant id</param> </member> <member name="M:CMS.PortalEngine.PageTemplateInstance.GetUniqueWebPartId(System.String,System.Int32)"> <summary> Returns unique web part ID within this Page template. </summary> <param name="baseId">Base web part id (required)</param> <param name="counterOffset">The counter number which will be used as a starter counter for checking the unique id. Example: counterOffset=2, returns ids starting with number two ('wp_2', 'wp_3', 'wp_4'...)</param> </member> <member name="M:CMS.PortalEngine.PageTemplateInstance.CanMoveWebPart(CMS.PortalEngine.WebPartInstance,CMS.PortalEngine.WebPartZoneInstance)"> <summary> Returns true if web part can be moved </summary> <param name="webPart">Web part to move</param> <param name="targetZoneInstance">Target zone instance</param> </member> <member name="P:CMS.PortalEngine.PageTemplateInstance.ControlIDReplaceRegex"> <summary> Gets the regular expression for valid control id. </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateInstance.WebPartZones"> <summary> Web part zones contained within the Page template. </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateInstance.WebParts"> <summary> Gets or sets the page template WebParts. </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateInstance.ParentPageTemplate"> <summary> Parent page template. </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateInstance.MVTVariantsLoaded"> <summary> Indicates whether MVT variants have been loaded for this page template instance. </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateInstance.ContentPersonalizationVariantsLoaded"> <summary> Indicates whether Content personalization variants have been loaded for this page template instance. </summary> </member> <member name="T:CMS.PortalEngine.VariantModeEnum"> <summary> Variant mode enumeration. </summary> </member> <member name="F:CMS.PortalEngine.VariantModeEnum.MVT"> <summary> MVT </summary> </member> <member name="F:CMS.PortalEngine.VariantModeEnum.ContentPersonalization"> <summary> Content personalization </summary> </member> <member name="F:CMS.PortalEngine.VariantModeEnum.Conflicted"> <summary> Both content personalization and MVT modes together - this is not allowed </summary> </member> <member name="F:CMS.PortalEngine.VariantModeEnum.None"> <summary> No variant mode set </summary> </member> <member name="T:CMS.PortalEngine.VariantModeFunctions"> <summary> Variant mode enumeration support functions. </summary> </member> <member name="M:CMS.PortalEngine.VariantModeFunctions.GetVariantModeEnum(System.String)"> <summary> Returns VariantModeEnum enum. </summary> <param name="variantMode">The variant mode</param> </member> <member name="M:CMS.PortalEngine.VariantModeFunctions.GetVariantModeString(CMS.PortalEngine.VariantModeEnum)"> <summary> Returns VariantModo string. </summary> <param name="variantMode">The variant mode</param> </member> <member name="T:CMS.PortalEngine.IAdminPage"> <summary> Interface for the admin pages. </summary> </member> <member name="T:CMS.PortalEngine.IPageManager"> <summary> Page manager interface. </summary> </member> <member name="M:CMS.PortalEngine.IPageManager.ClearCache"> <summary> Causes clearing the control data cache. </summary> </member> <member name="P:CMS.PortalEngine.IPageManager.ViewMode"> <summary> Current view mode. </summary> </member> <member name="P:CMS.PortalEngine.IPageManager.SiteName"> <summary> Page site name. </summary> </member> <member name="P:CMS.PortalEngine.IPageManager.IsAuthorized"> <summary> Returns true if the user is authorized for current document. </summary> </member> <member name="P:CMS.PortalEngine.IPageManager.CheckPermissions"> <summary> Gets or sets the value that indicates whether permissions for current document should be checked </summary> </member> <member name="T:CMS.PortalEngine.IPageInfo"> <summary> Page info interface </summary> </member> <member name="P:CMS.PortalEngine.IPageInfo.TemplateInstance"> <summary> Page template instance </summary> </member> <member name="P:CMS.PortalEngine.IPageInfo.DocumentTemplateInstance"> <summary> Document template instance </summary> </member> <member name="P:CMS.PortalEngine.IPageInfo.GroupTemplateInstance"> <summary> Group template instance </summary> </member> <member name="P:CMS.PortalEngine.IPageInfo.DocumentID"> <summary> Document ID </summary> </member> <member name="P:CMS.PortalEngine.IPageInfo.NodeID"> <summary> Node ID </summary> </member> <member name="P:CMS.PortalEngine.IPageInfo.DocumentCulture"> <summary> Document culture. </summary> </member> <member name="P:CMS.PortalEngine.IPageInfo.NodeAliasPath"> <summary> Node alias path. </summary> </member> <member name="T:CMS.PortalEngine.LayoutInfo"> <summary> Layout info data container class. </summary> </member> <member name="F:CMS.PortalEngine.LayoutInfo.OBJECT_TYPE"> <summary> Object type </summary> </member> <member name="F:CMS.PortalEngine.LayoutInfo.EXTERNAL_COLUMN_CODE"> <summary> External column name for Layout Code </summary> </member> <member name="F:CMS.PortalEngine.LayoutInfo.EXTERNAL_COLUMN_CSS"> <summary> External column name for Layout CSS </summary> </member> <member name="F:CMS.PortalEngine.LayoutInfo.TYPEINFO"> <summary> Type information. </summary> </member> <member name="M:CMS.PortalEngine.LayoutInfo.DeleteObject"> <summary> Deletes the object using appropriate provider. </summary> </member> <member name="M:CMS.PortalEngine.LayoutInfo.SetObject"> <summary> Updates the object using appropriate provider. </summary> </member> <member name="M:CMS.PortalEngine.LayoutInfo.GetVirtualFileRelativePath(System.String,System.String)"> <summary> Returns virtual relative path for specific column </summary> <param name="externalColumnName">External column name</param> <param name="versionGuid">Version GUID. If not defined physical path is generated</param> </member> <member name="M:CMS.PortalEngine.LayoutInfo.RegisterExternalColumns"> <summary> Returns path to externally stored layout codes. </summary> </member> <member name="M:CMS.PortalEngine.LayoutInfo.#ctor"> <summary> Constructor, creates an empty LayoutInfo structure. </summary> </member> <member name="M:CMS.PortalEngine.LayoutInfo.#ctor(System.Data.DataRow)"> <summary> Constructor, creates LayoutInfo object from the given DataRow data. </summary> <param name="dr">Datarow with the class info data</param> </member> <member name="M:CMS.PortalEngine.LayoutInfo.GetThemePath"> <summary> Gets the theme path for the object </summary> </member> <member name="M:CMS.PortalEngine.LayoutInfo.GetPermissionName(CMS.DataEngine.PermissionsEnum)"> <summary> Converts PermissionEnum to permission codename which will be checked when CheckPermission() is called. </summary> <param name="permission">Permission to convert to string</param> </member> <member name="M:CMS.PortalEngine.LayoutInfo.CheckPermissionsInternal(CMS.DataEngine.PermissionsEnum,System.String,CMS.Base.IUserInfo,System.Boolean)"> <summary> Checks the permissions of the object. </summary> <param name="permission">Permission type</param> <param name="siteName">Name of the site</param> <param name="userInfo">UserInfo object</param> <param name="exceptionOnFailure">If true, PermissionCheckException is thrown whenever a permission check fails</param> </member> <member name="M:CMS.PortalEngine.LayoutInfo.InsertAsCloneInternal(CMS.DataEngine.CloneSettings,CMS.DataEngine.CloneResult,CMS.DataEngine.BaseInfo)"> <summary> Inserts cloned object to DB. </summary> <param name="settings">Cloning settings</param> <param name="result">Cloning result</param> <param name="originalObject">Original source BaseInfo (object being cloned)</param> </member> <member name="P:CMS.PortalEngine.LayoutInfo.LayoutId"> <summary> The layout ID. </summary> </member> <member name="P:CMS.PortalEngine.LayoutInfo.LayoutDisplayName"> <summary> The layout display name. </summary> </member> <member name="P:CMS.PortalEngine.LayoutInfo.LayoutDescription"> <summary> The layout description. </summary> </member> <member name="P:CMS.PortalEngine.LayoutInfo.LayoutCSS"> <summary> Layout CSS. </summary> </member> <member name="P:CMS.PortalEngine.LayoutInfo.LayoutIsConvertible"> <summary> Layout is convertible. </summary> </member> <member name="P:CMS.PortalEngine.LayoutInfo.LayoutZoneCount"> <summary> Number of zones. </summary> </member> <member name="P:CMS.PortalEngine.LayoutInfo.LayoutZoneCountAutomatic"> <summary> Number of zones (counted automatically). </summary> </member> <member name="P:CMS.PortalEngine.LayoutInfo.LayoutType"> <summary> Layout type. </summary> </member> <member name="P:CMS.PortalEngine.LayoutInfo.LayoutCode"> <summary> The layout code. </summary> </member> <member name="P:CMS.PortalEngine.LayoutInfo.LayoutCodeName"> <summary> The layout code name. </summary> </member> <member name="P:CMS.PortalEngine.LayoutInfo.LayoutVersionGUID"> <summary> Layout version GUID. </summary> </member> <member name="P:CMS.PortalEngine.LayoutInfo.LayoutGUID"> <summary> Layout GUID. </summary> </member> <member name="P:CMS.PortalEngine.LayoutInfo.LayoutLastModified"> <summary> Object last modified. </summary> </member> <member name="P:CMS.PortalEngine.LayoutInfo.LayoutThumbnailGUID"> <summary> Layout thumbnail metafile GUID. </summary> </member> <member name="P:CMS.PortalEngine.LayoutInfo.LayoutIconClass"> <summary> Layout icon class defining the page layout thumbnail. </summary> </member> <member name="P:CMS.PortalEngine.LayoutInfo.UsesExternalStorage"> <summary> Indicates whether the theme path points at an external storage. </summary> </member> <member name="T:CMS.PortalEngine.LayoutInfoProvider"> <summary> Provides access to information about layout. </summary> </member> <member name="F:CMS.PortalEngine.LayoutInfoProvider.LAYOUTS_DIRECTORY"> <summary> Layouts directory. </summary> </member> <member name="F:CMS.PortalEngine.LayoutInfoProvider.mDefaultNamespaces"> <summary> List of default layout namespaces </summary> </member> <member name="M:CMS.PortalEngine.LayoutInfoProvider.#ctor"> <summary> Constructor. </summary> </member> <member name="M:CMS.PortalEngine.LayoutInfoProvider.GetVirtualObject(System.String)"> <summary> Returns layout info for specified path </summary> <param name="path">Path</param> </member> <member name="M:CMS.PortalEngine.LayoutInfoProvider.SetLayoutInfo(CMS.PortalEngine.LayoutInfo)"> <summary> Sets the specified layout data. </summary> <param name="layout">Layout object</param> </member> <member name="M:CMS.PortalEngine.LayoutInfoProvider.GetLayoutInfo(System.String)"> <summary> Returns the LayoutInfo structure for the specified layout. </summary> <param name="layoutCodeName">Layout code name</param> </member> <member name="M:CMS.PortalEngine.LayoutInfoProvider.GetLayoutInfo(System.Int32)"> <summary> Returns the LayoutInfo structure for the specified layout. </summary> <param name="layoutId">Layout ID</param> </member> <member name="M:CMS.PortalEngine.LayoutInfoProvider.DeleteLayoutInfo(CMS.PortalEngine.LayoutInfo)"> <summary> Deletes specified layout. </summary> <param name="layout">Layout object</param> </member> <member name="M:CMS.PortalEngine.LayoutInfoProvider.DeleteLayoutInfo(System.Int32)"> <summary> Deletes specified layout. </summary> <param name="layoutId">Layout ID</param> </member> <member name="M:CMS.PortalEngine.LayoutInfoProvider.GetLayouts"> <summary> Returns all layouts. </summary> </member> <member name="M:CMS.PortalEngine.LayoutInfoProvider.GetLayoutName(System.String)"> <summary> Returns full layout name from the given virtual layout path. </summary> <param name="url">Virtual layout path</param> </member> <member name="M:CMS.PortalEngine.LayoutInfoProvider.Clear(System.Boolean)"> <summary> Clears hashtables. </summary> <param name="logTasks">If true, web farm tasks are logged</param> </member> <member name="M:CMS.PortalEngine.LayoutInfoProvider.GetLayoutDirectives"> <summary> Layout directives are set before layout code. </summary> </member> <member name="M:CMS.PortalEngine.LayoutInfoProvider.AddLayoutDirectives(System.String,CMS.DataEngine.LayoutTypeEnum)"> <summary> Adds the layout directives to the transformation. </summary> <param name="code">Code of the layout</param> <param name="type">Type of the layout</param> </member> <member name="M:CMS.PortalEngine.LayoutInfoProvider.AddLayoutDirectives(System.String)"> <summary> Adds the layout directives to the transformation. </summary> <param name="code">Code of the layout</param> </member> <member name="M:CMS.PortalEngine.LayoutInfoProvider.GetLayoutTypeEnum(System.String)"> <summary> Gets the layout type enumeration for the given string value. </summary> <param name="type">String type</param> </member> <member name="M:CMS.PortalEngine.LayoutInfoProvider.GetLayoutTypeCode(CMS.DataEngine.LayoutTypeEnum)"> <summary> Gets the layout type code for the given enum value. </summary> <param name="type">String type</param> </member> <member name="M:CMS.PortalEngine.LayoutInfoProvider.CountWebpartZones(System.String,CMS.DataEngine.LayoutTypeEnum)"> <summary> Counts webpart zones in layout code. </summary> <param name="layoutCode">Layout code</param> <param name="layoutType">Layout code type enum</param> <returns>Number of webpart zones in layout code.</returns> </member> <member name="M:CMS.PortalEngine.LayoutInfoProvider.CountWebpartZones(System.String,System.String)"> <summary> Counts webpart zones in layout code. </summary> <param name="layoutCode">Layout code</param> <param name="layoutTypeName">Layout code type name</param> <returns>Number of webpart zones in layout code.</returns> </member> <member name="M:CMS.PortalEngine.LayoutInfoProvider.GetLayoutsInternal"> <summary> Get all layouts. </summary> <returns></returns> </member> <member name="M:CMS.PortalEngine.LayoutInfoProvider.SetLayoutInfoInternal(CMS.PortalEngine.LayoutInfo)"> <summary> Sets the specified layout data. </summary> <param name="layout">Layout object</param> </member> <member name="M:CMS.PortalEngine.LayoutInfoProvider.CountWebpartZonesInternal(System.String,CMS.DataEngine.LayoutTypeEnum)"> <summary> Counts webpart zones in layout code. </summary> <param name="layoutCode">Layout code</param> <param name="layoutType">Layout code</param> <returns>Number of webpart zones in layout code.</returns> </member> <member name="P:CMS.PortalEngine.LayoutInfoProvider.StoreLayoutsInExternalStorage"> <summary> Gets or sets the value that indicates whether shared layouts should be stored externally </summary> </member> <member name="P:CMS.PortalEngine.LayoutInfoProvider.LayoutsDirectory"> <summary> Gets layouts directory. </summary> </member> <member name="P:CMS.PortalEngine.LayoutInfoProvider.DefaultNamespaces"> <summary> List of default transformation namespaces </summary> </member> <member name="P:CMS.PortalEngine.LayoutInfoProvider.DefaultDirectives"> <summary> Returns list of default layout directives (ToLower). </summary> </member> <member name="T:CMS.PortalEngine.LayoutVirtualFileObject"> <summary> Layout virtual file object </summary> </member> <member name="M:CMS.PortalEngine.LayoutVirtualFileObject.#ctor(CMS.PortalEngine.LayoutInfo)"> <summary> Constructor </summary> <param name="currentObject">Object instance</param> </member> <member name="M:CMS.PortalEngine.LayoutVirtualFileObject.GetVirtualFileObject(System.String)"> <summary> Creates IVirtualFileObject for specified virtual path (GetVirtualFileObjectHandler callback method) </summary> <param name="virtualPath">Virtual path</param> </member> <member name="P:CMS.PortalEngine.LayoutVirtualFileObject.Content"> <summary> Gets virtual file content for current object </summary> </member> <member name="P:CMS.PortalEngine.LayoutVirtualFileObject.IsStoredExternally"> <summary> Indicates whether file content is stored externally (e.g. file system) </summary> </member> <member name="P:CMS.PortalEngine.LayoutVirtualFileObject.ObjectHash"> <summary> Gets object hash string used for identification of compiled version in .NET cache </summary> </member> <member name="P:CMS.PortalEngine.LayoutVirtualFileObject.PhysicalFilePath"> <summary> Gets the physical file path if exists </summary> </member> <member name="P:CMS.PortalEngine.LayoutVirtualFileObject.CurrentObject"> <summary> Current object instance </summary> </member> <member name="T:CMS.PortalEngine.WebPartInfoMethods"> <summary> Macro methods for class WebPartInfo </summary> </member> <member name="M:CMS.PortalEngine.WebPartInfoMethods.GetUsageObjectTypes(CMS.MacroEngine.EvaluationContext,System.Object[])"> <summary> Macro method for method GetUsageObjectTypes </summary> </member> <member name="M:CMS.PortalEngine.WebPartInfoMethods.GetUsages(CMS.MacroEngine.EvaluationContext,System.Object[])"> <summary> Macro method for method GetUsages </summary> </member> <member name="T:CMS.PortalEngine.ModuleUsageTracking.PortalEngineUsageDataSource"> <summary> Module usage data for portal engine. </summary> </member> <member name="M:CMS.PortalEngine.ModuleUsageTracking.PortalEngineUsageDataSource.GetData"> <summary> Get portal engine usage data. </summary> </member> <member name="M:CMS.PortalEngine.ModuleUsageTracking.PortalEngineUsageDataSource.GetCSSCount``1(CMS.DataEngine.ObjectQuery{``0},System.String)"> <summary> Gets the total number of objects which have defined custom CSS. </summary> <param name="query">The object query to be used for data retrieval</param> <param name="cssColumnName">Name of the column which carries CSS</param> </member> <member name="P:CMS.PortalEngine.ModuleUsageTracking.PortalEngineUsageDataSource.Name"> <summary> Portal engine usage data source name. </summary> </member> <member name="T:CMS.PortalEngine.CssStylesheetExport"> <summary> Handles special actions during the CSS stylesheet export process. </summary> </member> <member name="M:CMS.PortalEngine.CssStylesheetExport.Init"> <summary> Initializes export handlers </summary> </member> <member name="T:CMS.PortalEngine.ExportSpecialActions"> <summary> Handles special actions during the export process. </summary> </member> <member name="M:CMS.PortalEngine.ExportSpecialActions.Init"> <summary> Initializes export handlers </summary> </member> <member name="M:CMS.PortalEngine.ExportSpecialActions.CopyASPXTemplatesFolder(CMS.CMSImportExport.SiteExportSettings)"> <summary> Copy ASPX templates folder. </summary> <param name="settings">Export settings</param> </member> <member name="M:CMS.PortalEngine.ExportSpecialActions.CopyASPXTemplates(System.String,System.String,System.String[],System.String)"> <summary> Copy ASPX templates folder. </summary> <param name="sourcePath">Source path</param> <param name="targetPath">Target path</param> <param name="excludedNames">Excluded names</param> <param name="websitePath">Web site path</param> </member> <member name="T:CMS.PortalEngine.ImportSpecialActions"> <summary> Handles special actions during the import process. </summary> </member> <member name="M:CMS.PortalEngine.ImportSpecialActions.Init"> <summary> Initializes export handlers </summary> </member> <member name="T:CMS.PortalEngine.PageLayoutImport"> <summary> Handles special actions during the Page layout import process. </summary> </member> <member name="M:CMS.PortalEngine.PageLayoutImport.Init"> <summary> Initializes import handlers </summary> </member> <member name="T:CMS.PortalEngine.CssStylesheetImport"> <summary> Handles special actions during the CSS stylesheet import process. </summary> </member> <member name="M:CMS.PortalEngine.CssStylesheetImport.Init"> <summary> Initializes import handlers </summary> </member> <member name="T:CMS.PortalEngine.InlineControlExport"> <summary> Handles special actions during the Inline control export process. </summary> </member> <member name="M:CMS.PortalEngine.InlineControlExport.Init"> <summary> Initializes export handlers </summary> </member> <member name="T:CMS.PortalEngine.InlineControlImport"> <summary> Handles special actions during the Inline control import process. </summary> </member> <member name="M:CMS.PortalEngine.InlineControlImport.Init"> <summary> Initializes import handlers </summary> </member> <member name="T:CMS.PortalEngine.PageTemplateExport"> <summary> Handles special actions during the Page template export process. </summary> </member> <member name="M:CMS.PortalEngine.PageTemplateExport.Init"> <summary> Initializes export handlers </summary> </member> <member name="T:CMS.PortalEngine.PageTemplateImport"> <summary> Handles special actions during the Page template import process. </summary> </member> <member name="M:CMS.PortalEngine.PageTemplateImport.Init"> <summary> Initializes import handlers </summary> </member> <member name="M:CMS.PortalEngine.PageTemplateImport.PrepareDataStructure_ImportFromVersion9_HandleIsPortalColumnRemoval(System.Object,CMS.CMSImportExport.ImportGetDataEventArgs)"> <summary> Handles change in CMS_PageTemplate database table - PageTemplateType column is no longer nullable and PageTemplateIsPortal has been dropped. This method handles import packages from version 9 and earlier. </summary> </member> <member name="M:CMS.PortalEngine.PageTemplateImport.GetImportData_ImportFromVersion9_HandleIsPortalColumnRemoval(System.Object,CMS.CMSImportExport.ImportGetDataEventArgs)"> <summary> Handles change in CMS_PageTemplate database table - PageTemplateType column is no longer nullable and PageTemplateIsPortal has been dropped. This method handles import packages from version 9 and earlier. </summary> </member> <member name="M:CMS.PortalEngine.PageTemplateImport.AddASPXTemplatesFolder(CMS.CMSImportExport.SiteImportSettings)"> <summary> Add the ASPX templates folder to import file list. </summary> <param name="settings">Site import settings</param> </member> <member name="T:CMS.PortalEngine.WebPartExport"> <summary> Handles special actions during the Web part export process. </summary> </member> <member name="M:CMS.PortalEngine.WebPartExport.Init"> <summary> Initializes export handlers </summary> </member> <member name="M:CMS.PortalEngine.WebPartExport.GetDependentWebPart(CMS.DataEngine.GeneralizedInfo)"> <summary> Get list of dependent web parts for widget object </summary> <param name="infoObj">Widget object</param> </member> <member name="M:CMS.PortalEngine.WebPartExport.GetInheritedWebParts(CMS.DataEngine.GeneralizedInfo)"> <summary> Get list of inherited web parts for web part object </summary> <param name="infoObj">Web part object</param> </member> <member name="T:CMS.PortalEngine.WebPartImport"> <summary> Handles special actions during the Web part import process. </summary> </member> <member name="F:CMS.PortalEngine.WebPartImport.ObsoleteWebpartGUIDs"> <summary> List of obsolete webpart GUIDs. For web parts in this list we don't import files from earlier versions to prevent API changes conflicts. </summary> </member> <member name="M:CMS.PortalEngine.WebPartImport.Init"> <summary> Initializes import handlers </summary> </member> <member name="T:CMS.PortalEngine.WidgetExport"> <summary> Handles special actions during the Widget export process. </summary> </member> <member name="M:CMS.PortalEngine.WidgetExport.Init"> <summary> Initializes export handlers </summary> </member> <member name="T:CMS.PortalEngine.PortalHandlers"> <summary> Event handlers for portal engine module </summary> </member> <member name="M:CMS.PortalEngine.PortalHandlers.Init"> <summary> Initializes the handlers </summary> </member> <member name="M:CMS.PortalEngine.PortalHandlers.UpdateSession_Before(System.Object,CMS.Base.CMSEventArgs)"> <summary> Checks if the session can be updated </summary> </member> <member name="M:CMS.PortalEngine.PortalHandlers.SignOut_After(System.Object,CMS.Membership.SignOutEventArgs)"> <summary> Ensures LiveSite mode after SignOut </summary> </member> <member name="M:CMS.PortalEngine.PortalHandlers.ResolveSubstitutionMacro_Execute(System.Object,CMS.Localization.LocalizationEventArgs)"> <summary> Replaces special macros contained in resource string with navigation path to the given UI element. </summary> <param name="sender">Event argument</param> <param name="e">Sender object</param> </member> <member name="M:CMS.PortalEngine.PortalHandlers.ClearDeviceCache(System.Object,CMS.DataEngine.SettingsKeyChangedEventArgs)"> <summary> Settings key changed handler </summary> </member> <member name="M:CMS.PortalEngine.PortalHandlers.ClearTargetLayoutIdentifierHashtable(System.Object,CMS.DataEngine.ObjectEventArgs)"> <summary> Clears provider's cache of target layouts based on device profile and source layout. </summary> </member> <member name="T:CMS.PortalEngine.PortalModuleMetadata"> <summary> Represents the Portal module metadata. </summary> </member> <member name="M:CMS.PortalEngine.PortalModuleMetadata.#ctor"> <summary> Default constructor </summary> </member> <member name="T:CMS.PortalEngine.PageTemplateEvents"> <summary> Page templates events. </summary> </member> <member name="F:CMS.PortalEngine.PageTemplateEvents.PageTemplateCloneAsAdHoc"> <summary> Fires when template is cloned as ad-hoc. </summary> </member> <member name="T:CMS.PortalEngine.SiteService"> <summary> Site service </summary> </member> <member name="P:CMS.PortalEngine.SiteService.CurrentSite"> <summary> Current site </summary> </member> <member name="P:CMS.PortalEngine.SiteService.IsLiveSite"> <summary> Returns true, if the current context executes on live site </summary> </member> <member name="T:CMS.PortalEngine.Internal.IUILinkProvider"> <summary> Provides methods for generating links to access single objects within the module. (e.g. single Site). </summary> </member> <member name="M:CMS.PortalEngine.Internal.IUILinkProvider.GetSingleObjectLink(CMS.Modules.UIElementInfo,CMS.PortalEngine.ObjectDetailLinkParameters)"> <summary> Gets link to the single object if supported by the current state of UI elements. Can return link to the object creation if object identifier in <see cref="T:CMS.PortalEngine.ObjectDetailLinkParameters"/> is left empty. Leaving out the <see cref="T:CMS.PortalEngine.ObjectDetailLinkParameters"/> to null will return simple link for the object creation. </summary> <example> Following example shows how to obtain link to access single site. <code> var siteEditElement = UIElementInfoProvider.GetUIElementInfo("CMS", "EditSiteProperties"); var retriever = <see cref="M:CMS.Core.Service`1.Entry"/>; string link = retriever.GetSingleObjectLink(siteEditElement, new ObjectDetailLinkParemeters { ObjectIdentifier = "siteName", AllowNavigationToListing = true }); </code> </example> <param name="detailElement">UI element displaying the object detail</param> <param name="parameters">Additional parameters</param> <returns>Link to single object defined in <paramref name="detailElement"/> and <paramref name="parameters"/>.</returns> </member> <member name="M:CMS.PortalEngine.Internal.IUILinkProvider.GetSingleObjectLink(System.String,System.String,CMS.PortalEngine.ObjectDetailLinkParameters)"> <summary> Gets link to the single object if supported by the current state of UI elements.<br/> Can return link to the object creation if object identifier in <see cref="T:CMS.PortalEngine.ObjectDetailLinkParameters"/> is left empty. Leaving out the <see cref="T:CMS.PortalEngine.ObjectDetailLinkParameters"/> to null will return simple link for the object creation. </summary> /// <example> Following example shows how to obtain link to access single site. <code> var retriever = <see cref="M:CMS.Core.Service`1.Entry"/>; string link = retriever.GetSingleObjectLink("CMS", "EditSiteProperties" new ObjectDetailLinkParemeters { ObjectIdentifier = "siteName", AllowNavigationToListing = true }); </code> </example> <param name="moduleName">Module name</param> <param name="elementDetailName">Object detail element name</param> <param name="parameters">Additional parameters</param> <returns>Link to single object defined in <paramref name="moduleName"/>, <paramref name="elementDetailName"/> and <paramref name="parameters"/>.</returns> </member> <member name="T:CMS.PortalEngine.ObjectDetailLinkParameters"> <summary> Object detail link parameters. </summary> <remarks> Use when creating link to the object detail. </remarks> </member> <member name="P:CMS.PortalEngine.ObjectDetailLinkParameters.ObjectIdentifier"> <summary> Object id or object name. Can be left empty for object creation to be shown. </summary> </member> <member name="P:CMS.PortalEngine.ObjectDetailLinkParameters.ParentTabName"> <summary> Name of the parent tab name. Will be selected when navigating back in tabs. </summary> </member> <member name="P:CMS.PortalEngine.ObjectDetailLinkParameters.AllowNavigationToListing"> <summary> Navigation to the parent tabs will be possible if enabled. </summary> </member> <member name="P:CMS.PortalEngine.ObjectDetailLinkParameters.TabName"> <summary> Name of the tab. Can be used to navigate to an individual tab. </summary> </member> <member name="P:CMS.PortalEngine.ObjectDetailLinkParameters.ParentObjectIdentifier"> <summary> Parent id or parent name. </summary> </member> <member name="T:CMS.PortalEngine.GetDocLinkHandler"> <summary> <para> Handles requests for documentation. Redirects the client to documentation service with proper product version specified. </para> <para> Accessing the handler without "link" query parameter specified redirects the client to product documentation root. Accessing the handler with "link" query parameter redirects the client to documentation topic identified by "link". </para> </summary> <remarks> The handler is designed as reusable and therefore must be thread-safe. Keep that in mind when making any modifications. </remarks> </member> <member name="M:CMS.PortalEngine.GetDocLinkHandler.ProcessRequest(System.Web.HttpContext)"> <summary> Processes the documentation request. </summary> <param name="context"></param> </member> <member name="M:CMS.PortalEngine.GetDocLinkHandler.IsAbsoluteUrl(System.String)"> <summary> Returns true if <paramref name="url"/> is an absolute URL. </summary> <param name="url">URL to be validated.</param> <returns>True if URL is absolute, false otherwise.</returns> </member> <member name="P:CMS.PortalEngine.GetDocLinkHandler.PermanentLink"> <summary> Gets the permanent link from URL query string. Permanent link identifies the documentation topic. </summary> </member> <member name="P:CMS.PortalEngine.GetDocLinkHandler.IsReusable"> <summary> The handler is reusable. </summary> </member> <member name="T:CMS.PortalEngine.UILinkProvider"> <summary> Provides methods for generating links to access single objects within the module. (e.g. single Site). </summary> </member> <member name="M:CMS.PortalEngine.UILinkProvider.GetSingleObjectLink(CMS.Modules.UIElementInfo,CMS.PortalEngine.ObjectDetailLinkParameters)"> <summary> Gets link to the single object if supported by the current state of UI elements. Can return link to the object creation if object identifier in <see cref="T:CMS.PortalEngine.ObjectDetailLinkParameters"/> is left empty. Leaving out the <see cref="T:CMS.PortalEngine.ObjectDetailLinkParameters"/> will return simple link for the object creation. </summary> <param name="detailElement">UI element displaying the object detail</param> <param name="parameters">Additional parameters</param> <exception cref="T:System.ArgumentNullException"><paramref name="detailElement"/> is null</exception> <returns>Link to single object defined in <paramref name="detailElement"/> and <paramref name="parameters"/>.</returns> </member> <member name="M:CMS.PortalEngine.UILinkProvider.GetSingleObjectLink(System.String,System.String,CMS.PortalEngine.ObjectDetailLinkParameters)"> <summary> Gets link to the single object if supported by the current state of UI elements.<br/> Can return link to the object creation if object identifier in <see cref="T:CMS.PortalEngine.ObjectDetailLinkParameters"/> is left empty. Leaving out the <see cref="T:CMS.PortalEngine.ObjectDetailLinkParameters"/> will return simple link for the object creation. </summary> <param name="moduleName">Module name</param> <param name="elementDetailName">Object detail element name</param> <param name="parameters">Additional parameters</param> <exception cref="T:System.ArgumentException"> <paramref name="moduleName"/> is empty -or- <paramref name="elementDetailName"/> is empty -or- UI element with given <paramref name="moduleName"/> and <paramref name="elementDetailName"/> does not exist </exception> <returns>Link to single object defined in <paramref name="moduleName"/>, <paramref name="elementDetailName"/> and <paramref name="parameters"/>.</returns> </member> <member name="T:CMS.PortalEngine.PortalFormHelper"> <summary> Form info helper for portal engine purposes </summary> </member> <member name="F:CMS.PortalEngine.PortalFormHelper.PROPERTIES_BASE_PATH"> <summary> Base path for the default web part properties. </summary> </member> <member name="F:CMS.PortalEngine.PortalFormHelper.PROPERTIES_BASE_PHYSICAL_PATH"> <summary> Base physical path for the default web part properties. </summary> </member> <member name="F:CMS.PortalEngine.PortalFormHelper.BEFOREPROPERTIESDEFINITION"> <summary> Definition of 'before' properties for every UI element. </summary> </member> <member name="F:CMS.PortalEngine.PortalFormHelper.AFTERPROPERTIESDEFINITION"> <summary> Definition of 'after' properties for every UI element. </summary> </member> <member name="F:CMS.PortalEngine.PortalFormHelper.tableLock"> <summary> Lock for hashtable. </summary> </member> <member name="F:CMS.PortalEngine.PortalFormHelper.mPositionInfosWebParts"> <summary> Cached Before/After FormInfos for web parts. </summary> </member> <member name="F:CMS.PortalEngine.PortalFormHelper.mWidgetPartialFormInfos"> <summary> Cached partial FormInfos for widgets. </summary> </member> <member name="F:CMS.PortalEngine.PortalFormHelper.mWebPartFormInfos"> <summary> Cached web part FormInfo objects. </summary> </member> <member name="F:CMS.PortalEngine.PortalFormHelper.mWidgetFormInfos"> <summary> Cached widget FormInfo objects. </summary> </member> <member name="F:CMS.PortalEngine.PortalFormHelper.mUiTemplateDefaultProperties"> <summary> Cached Before/After FormInfo for UI page templates' properties. </summary> </member> <member name="M:CMS.PortalEngine.PortalFormHelper.Clear(System.Boolean)"> <summary> Clears all cached objects. </summary> <param name="logTasks">If true, web farm tasks are logged</param> </member> <member name="M:CMS.PortalEngine.PortalFormHelper.ClearWebPartFormInfos(System.Boolean)"> <summary> Clears cached web part FormInfos. </summary> <param name="logTasks">If true, web farm tasks are logged</param> </member> <member name="M:CMS.PortalEngine.PortalFormHelper.ClearWidgetFormInfos(System.Boolean)"> <summary> Clears cached web part FormInfos. </summary> <param name="logTasks">If true, web farm tasks are logged</param> </member> <member name="M:CMS.PortalEngine.PortalFormHelper.GetWebPartFormInfo(System.String,System.String,CMS.FormEngine.FormInfo,CMS.FormEngine.FormInfo,System.Boolean,System.String)"> <summary> Returns cached and merged FormInfo for web parts. </summary> <param name="webPartName">Name of the web part. Use suffix FormHelper.CORE to set different name for form info which doesn't contain before/after definitions</param> <param name="webPartProperties">XML schema for web part FormInfo</param> <param name="beforeDefinition">FormInfo for Before definition of the web part</param> <param name="afterDefinition">FormInfo for After definition of the web part</param> <param name="clone">When returned FormInfo is used only for reading then cloning can be set to FALSE</param> <param name="defaultValues">XML definitions with overridden system default values</param> <returns>Returns FormInfo object</returns> </member> <member name="M:CMS.PortalEngine.PortalFormHelper.GetWidgetFormInfo(System.String,CMS.PortalEngine.WidgetZoneTypeEnum,System.String,System.Boolean,System.String)"> <summary> Returns cached and merged FormInfo for widgets. </summary> <param name="widgetName">Name of the widget</param> <param name="zoneType">Type of the zone where widget is placed</param> <param name="widgetPropertiesFormDefinition">Widget properties form definition</param> <param name="clone">When returned FormInfo is used only for reading then cloning can be set to FALSE</param> <param name="defaultValuesFormDefinition">Form definition with overridden system default values</param> <returns>Returns FormInfo object</returns> </member> <member name="M:CMS.PortalEngine.PortalFormHelper.GetWebPartProperties(CMS.PortalEngine.WebPartTypeEnum,CMS.PortalEngine.PropertiesPosition)"> <summary> Gets web part properties. </summary> <param name="type">Type of the web part</param> <param name="position">Position of the properties</param> </member> <member name="M:CMS.PortalEngine.PortalFormHelper.ResolvePropertyGroups(System.String)"> <summary> Resolves the property groups in the given XML </summary> <param name="xml">XML to resolve</param> </member> <member name="M:CMS.PortalEngine.PortalFormHelper.ResolvePropertyGroup(System.Text.RegularExpressions.Match)"> <summary> Resolves the property group </summary> <param name="m">Regular expression match</param> </member> <member name="M:CMS.PortalEngine.PortalFormHelper.LoadProperties(System.String,System.String)"> <summary> Loads the properties file </summary> <param name="folder">Folder with the properties</param> <param name="fileName">File name</param> </member> <member name="M:CMS.PortalEngine.PortalFormHelper.GetPropertiesBasePath"> <summary> Gets the base path for the default web part properties </summary> </member> <member name="M:CMS.PortalEngine.PortalFormHelper.GetPositionFormInfo(CMS.PortalEngine.WebPartTypeEnum,CMS.PortalEngine.PropertiesPosition)"> <summary> Returns FormInfo for Before/After section of a web part </summary> <param name="type">Type of the web part</param> <param name="position">Content position</param> <returns>Returns FormInfo for the specified web part. Returns NULL if nothing found.</returns> </member> <member name="M:CMS.PortalEngine.PortalFormHelper.GetUIElementDefaultPropertiesForm(CMS.PortalEngine.UIElementPropertiesPosition)"> <summary> Returns general FormInfo pro UI templates (stored in XML file) </summary> <param name="position">Requested form info position</param> </member> <member name="M:CMS.PortalEngine.PortalFormHelper.GetDefaultWebPartProperties(CMS.PortalEngine.WebPartInfo)"> <summary> Gets the default properties for the given web part </summary> <param name="wpi">Web part</param> </member> <member name="P:CMS.PortalEngine.PortalFormHelper.WebPartFormInfos"> <summary> Cached web part FormInfo objects. </summary> </member> <member name="P:CMS.PortalEngine.PortalFormHelper.WidgetFormInfos"> <summary> Cached widget FormInfo objects. </summary> </member> <member name="T:CMS.PortalEngine.PropertiesPosition"> <summary> Web part properties position enumeration. </summary> </member> <member name="F:CMS.PortalEngine.PropertiesPosition.Before"> <summary> Before custom properties. </summary> </member> <member name="F:CMS.PortalEngine.PropertiesPosition.After"> <summary> After custom properties. </summary> </member> <member name="T:CMS.PortalEngine.PageTemplateDeviceLayoutInfo"> <summary> Page template device layout info data container class. </summary> </member> <member name="F:CMS.PortalEngine.PageTemplateDeviceLayoutInfo.OBJECT_TYPE"> <summary> Object type </summary> </member> <member name="F:CMS.PortalEngine.PageTemplateDeviceLayoutInfo.EXTERNAL_COLUMN_CODE"> <summary> External column name for Layout Code </summary> </member> <member name="F:CMS.PortalEngine.PageTemplateDeviceLayoutInfo.EXTERNAL_COLUMN_CSS"> <summary> External column name for Layout CSS </summary> </member> <member name="F:CMS.PortalEngine.PageTemplateDeviceLayoutInfo.TYPEINFO"> <summary> Type information. </summary> </member> <member name="M:CMS.PortalEngine.PageTemplateDeviceLayoutInfo.DeleteObject"> <summary> Deletes the object using appropriate provider. </summary> </member> <member name="M:CMS.PortalEngine.PageTemplateDeviceLayoutInfo.SetObject"> <summary> Updates the object using appropriate provider. </summary> </member> <member name="M:CMS.PortalEngine.PageTemplateDeviceLayoutInfo.GetVirtualFileRelativePath(System.String,System.String)"> <summary> Returns virtual relative path for specific column </summary> <param name="externalColumnName">External column name</param> <param name="versionGuid">Version GUID. If not defined physical path is generated</param> </member> <member name="M:CMS.PortalEngine.PageTemplateDeviceLayoutInfo.RegisterExternalColumns"> <summary> Returns path to externally stored layout codes. </summary> </member> <member name="M:CMS.PortalEngine.PageTemplateDeviceLayoutInfo.#ctor"> <summary> Constructor - Creates an empty ReportSubscriptionInfo object. </summary> </member> <member name="M:CMS.PortalEngine.PageTemplateDeviceLayoutInfo.#ctor(System.Data.DataRow)"> <summary> Constructor - Creates a new ReportSubscriptionInfo object from the given DataRow. </summary> <param name="dr">DataRow with the object data.</param> </member> <member name="M:CMS.PortalEngine.PageTemplateDeviceLayoutInfo.#ctor(CMS.PortalEngine.PageTemplateDeviceLayoutInfo,System.Boolean)"> <summary> Constructor - Creates a new ReportSubscriptionInfo object from the given DataClass. </summary> <param name="subscriptionObj">Source ReportSubscriptionInfo object.</param> <param name="keepSourceData">If true, source data are kept in the object.</param> </member> <member name="M:CMS.PortalEngine.PageTemplateDeviceLayoutInfo.GetPermissionName(CMS.DataEngine.PermissionsEnum)"> <summary> Converts PermissionEnum to permission codename which will be checked when CheckPermission() is called. </summary> <param name="permission">Permission to convert to string</param> </member> <member name="M:CMS.PortalEngine.PageTemplateDeviceLayoutInfo.CheckPermissionsInternal(CMS.DataEngine.PermissionsEnum,System.String,CMS.Base.IUserInfo,System.Boolean)"> <summary> Checks the permissions of the object. </summary> <param name="permission">Permission type</param> <param name="siteName">Name of the site</param> <param name="userInfo">UserInfo object</param> <param name="exceptionOnFailure">If true, PermissionCheckException is thrown whenever a permission check fails</param> </member> <member name="P:CMS.PortalEngine.PageTemplateDeviceLayoutInfo.LayoutLastModified"> <summary> Gets or sets the last modified value </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateDeviceLayoutInfo.LayoutFullName"> <summary> Gets the full name in format templateid.deviceid </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateDeviceLayoutInfo.ObjectFullName"> <summary> Gets the full name in format sitename.devicename.pagetemplatename </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateDeviceLayoutInfo.LayoutVersionGUID"> <summary> Layout version GUID. </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateDeviceLayoutInfo.TemplateDeviceLayoutID"> <summary> Template device layout id. </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateDeviceLayoutInfo.PageTemplateID"> <summary> Page template id. </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateDeviceLayoutInfo.ProfileID"> <summary> Device profile id. </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateDeviceLayoutInfo.LayoutID"> <summary> Layout id. </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateDeviceLayoutInfo.LayoutCode"> <summary> Layout code. </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateDeviceLayoutInfo.LayoutType"> <summary> Layout type. </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateDeviceLayoutInfo.LayoutCSS"> <summary> Layout CSS. </summary> </member> <member name="T:CMS.PortalEngine.PageTemplateDeviceLayoutInfoProvider"> <summary> Provides access to information about page template device layouts. </summary> </member> <member name="F:CMS.PortalEngine.PageTemplateDeviceLayoutInfoProvider.mDeviceLayoutsDirectory"> <summary> DeviceProfile layout directory directory. </summary> </member> <member name="F:CMS.PortalEngine.PageTemplateDeviceLayoutInfoProvider.mAdHocDeviceLayoutsDirectory"> <summary> AdHoc DeviceProfile layout directory directory. </summary> </member> <member name="M:CMS.PortalEngine.PageTemplateDeviceLayoutInfoProvider.#ctor"> <summary> Constructor. </summary> </member> <member name="M:CMS.PortalEngine.PageTemplateDeviceLayoutInfoProvider.GetTemplateDeviceLayoutInfo(System.Int32,System.Int32)"> <summary> Returns TemplateDeviceInfo for specified template and device profile. </summary> <param name="templateId">Template id</param> <param name="deviceProfileId">Device profile id</param> </member> <member name="M:CMS.PortalEngine.PageTemplateDeviceLayoutInfoProvider.GetTemplateDeviceLayouts"> <summary> Returns all template device layouts. </summary> </member> <member name="M:CMS.PortalEngine.PageTemplateDeviceLayoutInfoProvider.GetTemplateDeviceLayoutInfo(System.Int32)"> <summary> Returns template device layout with specified ID. </summary> <param name="deviceLayoutId">Template device layout ID.</param> </member> <member name="M:CMS.PortalEngine.PageTemplateDeviceLayoutInfoProvider.SetTemplateDeviceLayoutInfo(CMS.PortalEngine.PageTemplateDeviceLayoutInfo)"> <summary> Sets (updates or inserts) specified template device layout. </summary> <param name="deviceLayoutObj">Template device layout to be set.</param> </member> <member name="M:CMS.PortalEngine.PageTemplateDeviceLayoutInfoProvider.DeleteTemplateDeviceLayoutInfo(CMS.PortalEngine.PageTemplateDeviceLayoutInfo)"> <summary> Deletes specified template device layout. </summary> <param name="deviceLayoutObj">Template device layout to be deleted.</param> </member> <member name="M:CMS.PortalEngine.PageTemplateDeviceLayoutInfoProvider.DeleteTemplateDeviceLayoutInfo(System.Int32)"> <summary> Deletes template device layout with specified ID. </summary> <param name="deviceLayoutId">Template device layout ID.</param> </member> <member name="M:CMS.PortalEngine.PageTemplateDeviceLayoutInfoProvider.GetPageTemplateDeviceLayoutsInternal"> <summary> Get all page template device layouts. </summary> </member> <member name="M:CMS.PortalEngine.PageTemplateDeviceLayoutInfoProvider.GetFullNameDictionary"> <summary> Creates new dictionary for caching the objects by full name </summary> </member> <member name="M:CMS.PortalEngine.PageTemplateDeviceLayoutInfoProvider.GetFullNameWhereCondition(System.String)"> <summary> Gets the where condition that searches the object based on the given full name </summary> <param name="fullName">Object full name</param> </member> <member name="M:CMS.PortalEngine.PageTemplateDeviceLayoutInfoProvider.GetTemplateDeviceLayoutInfoInternal(System.Int32,System.Int32)"> <summary> Returns TemplateDeviceInfo for specified template and device profile. </summary> <param name="templateId">Template id</param> <param name="deviceProfileId">Device profile id</param> </member> <member name="M:CMS.PortalEngine.PageTemplateDeviceLayoutInfoProvider.GetTemplateDeviceLayoutInfoInternal(System.Int32)"> <summary> Returns template device layout with specified ID. </summary> <param name="templateDevicelayoutId">Device layout ID.</param> </member> <member name="M:CMS.PortalEngine.PageTemplateDeviceLayoutInfoProvider.SetTemplateDeviceLayoutInfoInternal(CMS.PortalEngine.PageTemplateDeviceLayoutInfo)"> <summary> Sets (updates or inserts) specified template device layout info. </summary> <param name="templateDevicelayoutObj">Device layout to be set.</param> </member> <member name="M:CMS.PortalEngine.PageTemplateDeviceLayoutInfoProvider.DeleteTemplateDeviceLayoutInfoInternal(CMS.PortalEngine.PageTemplateDeviceLayoutInfo)"> <summary> Deletes specified template device layout. </summary> <param name="templateDevicelayoutObj">Device layout to be deleted.</param> </member> <member name="M:CMS.PortalEngine.PageTemplateDeviceLayoutInfoProvider.GetLayoutObject(CMS.PortalEngine.PageTemplateInfo,CMS.DeviceProfiles.DeviceProfileInfo)"> <summary> Returns the layout object and type for specific page template </summary> <param name="ti">Template info</param> <param name="dpi">Current device profile info</param> </member> <member name="M:CMS.PortalEngine.PageTemplateDeviceLayoutInfoProvider.GetLayoutObject(CMS.PortalEngine.PageTemplateInfo,CMS.DeviceProfiles.DeviceProfileInfo,CMS.PortalEngine.PageTemplateLayoutTypeEnum@)"> <summary> Returns the layout object and type for specific page template </summary> <param name="ti">Template info</param> <param name="dpi">Current device profile info</param> <param name="type">Template layout type</param> </member> <member name="M:CMS.PortalEngine.PageTemplateDeviceLayoutInfoProvider.CloneInfoObject(CMS.DataEngine.BaseInfo,System.Int32)"> <summary> Clone the info object and combine it with the layout content (layout code, type, css...). </summary> <param name="infoObj">The source info object</param> <param name="layoutId">The id of the source layout</param> </member> <member name="M:CMS.PortalEngine.PageTemplateDeviceLayoutInfoProvider.GetVirtualObject(System.String,System.Boolean)"> <summary> Returns web part layout info for specified path </summary> <param name="path">Path</param> <param name="isAdHoc">Indicates whether current object has binding on ad-hoc template</param> </member> <member name="M:CMS.PortalEngine.PageTemplateDeviceLayoutInfoProvider.GetDeviceLayoutName(System.String,System.Boolean,System.Collections.Generic.List{System.String}@)"> <summary> Returns device layout name and prefixes if available </summary> <param name="path">Current path</param> <param name="isAdHoc">Indicates whether layout is on AdHoc page template</param> <param name="prefixes">Path prefixes</param> </member> <member name="P:CMS.PortalEngine.PageTemplateDeviceLayoutInfoProvider.DeviceLayoutsDirectory"> <summary> Gets device profile layouts directory. </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateDeviceLayoutInfoProvider.AdHocDeviceLayoutsDirectory"> <summary> Gets device profile AdHoc layouts directory. </summary> </member> <member name="T:CMS.PortalEngine.PageTemplateLayoutTypeEnum"> <summary> Layout types enum </summary> </member> <member name="F:CMS.PortalEngine.PageTemplateLayoutTypeEnum.SharedLayout"> <summary> Shared layout </summary> </member> <member name="F:CMS.PortalEngine.PageTemplateLayoutTypeEnum.SharedLayoutMapped"> <summary> Shared layout mapped </summary> </member> <member name="F:CMS.PortalEngine.PageTemplateLayoutTypeEnum.PageTemplateLayout"> <summary> Custom page template layout </summary> </member> <member name="F:CMS.PortalEngine.PageTemplateLayoutTypeEnum.DeviceSharedLayout"> <summary> Shared layout defined in device layout </summary> </member> <member name="F:CMS.PortalEngine.PageTemplateLayoutTypeEnum.DeviceLayout"> <summary> Custom device layout </summary> </member> <member name="F:CMS.PortalEngine.PageTemplateListInfo.OBJECT_TYPE"> <summary> Object type </summary> </member> <member name="F:CMS.PortalEngine.PageTemplateListInfo.TYPEINFO"> <summary> Type information. </summary> </member> <member name="M:CMS.PortalEngine.PageTemplateListInfo.#ctor"> <summary> Constructor - Creates an empty PageTemplateCategoryListInfo object. </summary> </member> <member name="M:CMS.PortalEngine.PageTemplateListInfo.#ctor(System.Data.DataRow)"> <summary> Constructor - Creates a new PageTemplateCategoryListInfo object from the given DataRow. </summary> <param name="dr">DataRow with the object data</param> </member> <member name="M:CMS.PortalEngine.PageTemplateListInfo.GetColumnNames"> <summary> Gets the default list of column names for this class </summary> </member> <member name="M:CMS.PortalEngine.PageTemplateListInfo.GetDataQueryInternal"> <summary> Gets the data query for this object type </summary> </member> <member name="T:CMS.PortalEngine.PageTemplateVirtualFileObject"> <summary> Page template layout virtual file object </summary> </member> <member name="M:CMS.PortalEngine.PageTemplateVirtualFileObject.#ctor(CMS.PortalEngine.PageTemplateInfo)"> <summary> Constructor </summary> <param name="currentObject">Object instance</param> </member> <member name="M:CMS.PortalEngine.PageTemplateVirtualFileObject.GetVirtualFileObject(System.String)"> <summary> Creates IVirtualFileObject for specified virtual path (GetVirtualFileObjectHandler callback method) </summary> <param name="virtualPath">Virtual path</param> </member> <member name="M:CMS.PortalEngine.PageTemplateVirtualFileObject.GetAdHocVirtualFileObject(System.String)"> <summary> Creates IVirtualFileObject for specified virtual path (GetVirtualFileObjectHandler callback method) </summary> <param name="virtualPath">Virtual path</param> </member> <member name="M:CMS.PortalEngine.PageTemplateVirtualFileObject.GetVirtualFileObjectInternal(System.String,System.Boolean)"> <summary> Creates IVirtualFileObject for specified virtual path (GetVirtualFileObjectHandler callback method) </summary> <param name="virtualPath">Virtual path</param> <param name="adHoc">Indicates whether page template is AdHoc</param> </member> <member name="P:CMS.PortalEngine.PageTemplateVirtualFileObject.Content"> <summary> Gets virtual file content for current object </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateVirtualFileObject.IsStoredExternally"> <summary> Indicates whether file content is stored externally (e.g. file system) </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateVirtualFileObject.ObjectHash"> <summary> Gets object hash string used for identification of compiled version in .NET cache </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateVirtualFileObject.PhysicalFilePath"> <summary> Gets the physical file path if exists </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateVirtualFileObject.CurrentObject"> <summary> Current object instance </summary> </member> <member name="T:CMS.PortalEngine.PageTemplateScopeInfo"> <summary> PageTemplateScopeInfo data container class. </summary> </member> <member name="F:CMS.PortalEngine.PageTemplateScopeInfo.OBJECT_TYPE"> <summary> Object type </summary> </member> <member name="F:CMS.PortalEngine.PageTemplateScopeInfo.TYPEINFO"> <summary> Type information. </summary> </member> <member name="M:CMS.PortalEngine.PageTemplateScopeInfo.DeleteObject"> <summary> Deletes the object using appropriate provider. </summary> </member> <member name="M:CMS.PortalEngine.PageTemplateScopeInfo.SetObject"> <summary> Updates the object using appropriate provider. </summary> </member> <member name="M:CMS.PortalEngine.PageTemplateScopeInfo.UpdateData"> <summary> Updates the object. </summary> </member> <member name="M:CMS.PortalEngine.PageTemplateScopeInfo.InsertData"> <summary> Inserts the object. </summary> </member> <member name="M:CMS.PortalEngine.PageTemplateScopeInfo.DeleteData"> <summary> Deletes the object. </summary> </member> <member name="M:CMS.PortalEngine.PageTemplateScopeInfo.#ctor"> <summary> Constructor - Creates an empty PageTemplateScopeInfo object. </summary> </member> <member name="M:CMS.PortalEngine.PageTemplateScopeInfo.#ctor(System.Data.DataRow)"> <summary> Constructor - Creates a new PageTemplateScopeInfo object from the given DataRow. </summary> </member> <member name="M:CMS.PortalEngine.PageTemplateScopeInfo.TouchParent"> <summary> Used to actualize time stamp of parent object for incremental deployment It's necessary to do not create parent object version, staging task or event log </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateScopeInfo.PageTemplateScopeID"> <summary> Page template scope id. </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateScopeInfo.PageTemplateScopeCultureID"> <summary> Page template scope culture id. </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateScopeInfo.PageTemplateScopePath"> <summary> Page template scope path. </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateScopeInfo.PageTemplateScopeClassID"> <summary> Page template scope class id. </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateScopeInfo.PageTemplateScopeLevels"> <summary> Page template scope levels. </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateScopeInfo.PageTemplateScopeSiteID"> <summary> Page template scope site id. </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateScopeInfo.PageTemplateScopeTemplateID"> <summary> Page template scope template id. </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateScopeInfo.PageTemplateScopeGUID"> <summary> Scope step GUID. </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateScopeInfo.PageTemplateScopeLastModified"> <summary> Object last modified. </summary> </member> <member name="T:CMS.PortalEngine.PageTemplateScopeInfoProvider"> <summary> Class providing PageTemplateScopeInfo management. </summary> </member> <member name="M:CMS.PortalEngine.PageTemplateScopeInfoProvider.GetPageTemplateScopeInfo(System.Int32)"> <summary> Returns the PageTemplateScopeInfo structure for the specified pageTemplateScope. </summary> <param name="pageTemplateScopeId">PageTemplateScope id</param> </member> <member name="M:CMS.PortalEngine.PageTemplateScopeInfoProvider.SetPageTemplateScopeInfo(CMS.PortalEngine.PageTemplateScopeInfo)"> <summary> Sets (updates or inserts) specified pageTemplateScope. </summary> <param name="pageTemplateScope">PageTemplateScope to set</param> </member> <member name="M:CMS.PortalEngine.PageTemplateScopeInfoProvider.DeletePageTemplateScopeInfo(CMS.PortalEngine.PageTemplateScopeInfo)"> <summary> Deletes specified pageTemplateScope. </summary> <param name="infoObj">PageTemplateScope object</param> </member> <member name="M:CMS.PortalEngine.PageTemplateScopeInfoProvider.DeletePageTemplateScopeInfo(System.Int32)"> <summary> Deletes specified pageTemplateScope. </summary> <param name="pageTemplateScopeId">PageTemplateScope id</param> </member> <member name="M:CMS.PortalEngine.PageTemplateScopeInfoProvider.GetTemplateScopes"> <summary> Returns all page template scopes. </summary> </member> <member name="M:CMS.PortalEngine.PageTemplateScopeInfoProvider.GetScopeTemplates(System.String,System.String,System.String,System.Int32,System.String)"> <summary> Returns all templates matching scope criteria. </summary> <param name="path">Page template path</param> <param name="cultureCode">Culture code</param> <param name="classNames">Class names</param> <param name="level">Level</param> <param name="siteName">Site name</param> </member> <member name="M:CMS.PortalEngine.PageTemplateScopeInfoProvider.GetScopeWhereCondition(System.String,System.String,System.String,System.Int32,System.String,System.String)"> <summary> Returns where condition for template scope. </summary> <param name="path">Page template path</param> <param name="cultureCode">Culture code</param> <param name="classNames">Class names separated by semicolon</param> <param name="level">Scope level</param> <param name="templateIdColumnName">ID column name</param> <param name="siteName">Site name</param> </member> <member name="M:CMS.PortalEngine.PageTemplateScopeInfoProvider.GetTemplateScopesInternal"> <summary> Returns all page template scopes. </summary> </member> <member name="M:CMS.PortalEngine.PageTemplateScopeInfoProvider.GetPageTemplateScopeInfoInternal(System.Int32)"> <summary> Returns the PageTemplateScopeInfo structure for the specified pageTemplateScope. </summary> <param name="pageTemplateScopeId">PageTemplateScope id</param> </member> <member name="M:CMS.PortalEngine.PageTemplateScopeInfoProvider.DeletePageTemplateScopeInfoInternal(CMS.PortalEngine.PageTemplateScopeInfo)"> <summary> Deletes specified pageTemplateScope. </summary> <param name="infoObj">PageTemplateScope object</param> </member> <member name="M:CMS.PortalEngine.PageTemplateScopeInfoProvider.SetPageTemplateScopeInfoInternal(CMS.PortalEngine.PageTemplateScopeInfo)"> <summary> Sets (updates or inserts) specified pageTemplateScope. </summary> <param name="pageTemplateScope">PageTemplateScope to set</param> </member> <member name="T:CMS.PortalEngine.PageTemplateTypeEnum"> <summary> Page template type enumeration. </summary> </member> <member name="F:CMS.PortalEngine.PageTemplateTypeEnum.Unknown"> <summary> Unknown type. </summary> </member> <member name="F:CMS.PortalEngine.PageTemplateTypeEnum.Portal"> <summary> Portal page template. </summary> </member> <member name="F:CMS.PortalEngine.PageTemplateTypeEnum.Aspx"> <summary> ASPX page template. </summary> </member> <member name="F:CMS.PortalEngine.PageTemplateTypeEnum.AspxPortal"> <summary> ASPX page template with portal enabled. </summary> </member> <member name="F:CMS.PortalEngine.PageTemplateTypeEnum.Dashboard"> <summary> Dashboard template. </summary> </member> <member name="F:CMS.PortalEngine.PageTemplateTypeEnum.MVC"> <summary> MVC template </summary> </member> <member name="F:CMS.PortalEngine.PageTemplateTypeEnum.UI"> <summary> UI template </summary> </member> <member name="T:CMS.PortalEngine.PortalModule"> <summary> Represents the Portal module. </summary> </member> <member name="M:CMS.PortalEngine.PortalModule.#ctor"> <summary> Default constructor </summary> </member> <member name="M:CMS.PortalEngine.PortalModule.RegisterCommands"> <summary> Registers the object type of this module </summary> </member> <member name="M:CMS.PortalEngine.PortalModule.OnPreInit"> <summary> Pre-initializes the module </summary> </member> <member name="M:CMS.PortalEngine.PortalModule.OnInit"> <summary> Init module </summary> </member> <member name="M:CMS.PortalEngine.PortalModule.InitSynchronization"> <summary> Excludes set of hidden system keys from synchronization. </summary> </member> <member name="M:CMS.PortalEngine.PortalModule.InitImportExport"> <summary> Initializes import/export handlers </summary> </member> <member name="M:CMS.PortalEngine.PortalModule.InitMacros"> <summary> Initializes the Portal engine macros </summary> </member> <member name="M:CMS.PortalEngine.PortalModule.RegisterMacroMethods"> <summary> Registers macro methods. </summary> </member> <member name="M:CMS.PortalEngine.PortalModule.CssPreprocessorsDatasourceOptions(System.Object[])"> <summary> The implementation of CssPreprocessorsDatasourceOptions macro method. Return list of value;name separated by EOL character. </summary> </member> <member name="M:CMS.PortalEngine.PortalModule.CssPreprocessorDisplayName(System.Object[])"> <summary> The implementation of CssPreprocessorName macro method. Returns string that represents the display name of CSS preprocessor given by an argument. </summary> </member> <member name="M:CMS.PortalEngine.PortalModule.RegisterVirtualPaths"> <summary> Registers the virtual paths to the virtual path provider </summary> </member> <member name="M:CMS.PortalEngine.PortalModule.RefreshDataCounts(System.Object[])"> <summary> Refreshes the data counts for the given object </summary> <param name="parameters">Parameters array</param> </member> <member name="M:CMS.PortalEngine.PortalModule.ClearHashtables(System.Boolean)"> <summary> Clears the module hashtables. </summary> <param name="logTasks">If true, web farm tasks are logged</param> </member> <member name="T:CMS.PortalEngine.DefaultTransformationTypeEnum"> <summary> Enumeration for file size units. </summary> </member> <member name="F:CMS.PortalEngine.DefaultTransformationTypeEnum.Default"> <summary> Default transformation type. </summary> </member> <member name="F:CMS.PortalEngine.DefaultTransformationTypeEnum.RSS"> <summary> RSS transformation type. </summary> </member> <member name="F:CMS.PortalEngine.DefaultTransformationTypeEnum.Atom"> <summary> Atom transformation type. </summary> </member> <member name="F:CMS.PortalEngine.DefaultTransformationTypeEnum.XML"> <summary> XML transformation type. </summary> </member> <member name="T:CMS.PortalEngine.TransformationFullNameWhereConditionBuilder"> <summary> Builds where condition to get transformation based on its full name. </summary> </member> <member name="M:CMS.PortalEngine.TransformationFullNameWhereConditionBuilder.#ctor(System.String)"> <summary> Creates instance of <see cref="T:CMS.PortalEngine.TransformationFullNameWhereConditionBuilder"/> class. </summary> <param name="fullName">Full name to use for building the where condition.</param> </member> <member name="M:CMS.PortalEngine.TransformationFullNameWhereConditionBuilder.Build"> <summary> Builds the full name where condition for the given full name of the transformation. </summary> </member> <member name="T:CMS.PortalEngine.TransformationMacroMethods"> <summary> Content methods - wrapping methods for macro resolver. </summary> </member> <member name="M:CMS.PortalEngine.TransformationMacroMethods.ApplyTransformation(CMS.MacroEngine.EvaluationContext,System.Object[])"> <summary> Applies transformation to list of items. </summary> <param name="context">Evaluation context with child resolver</param> <param name="parameters">Collection of items as the first parameter, item transformation name as the second. Optionally, Content-before and content-after transformations may be supplied as 3. and 4. parameters.</param> </member> <member name="M:CMS.PortalEngine.TransformationMacroMethods.Transform(CMS.MacroEngine.EvaluationContext,System.Object[])"> <summary> Applies ad-hoc text transformation to list of items. </summary> <param name="context">Evaluation context with child resolver</param> <param name="parameters">Collection of items as the first parameter, transformation text as the second</param> </member> <member name="M:CMS.PortalEngine.TransformationMacroMethods.GetTransformationCode(System.String)"> <summary> Returns code of the specified transformation. If such transformation is not found, input string is returned without any change. </summary> <param name="transformation">Transformation name or transformation code</param> </member> <member name="T:CMS.PortalEngine.TransformationInfo"> <summary> Class to use for storing the transformation data. </summary> </member> <member name="F:CMS.PortalEngine.TransformationInfo.OBJECT_TYPE"> <summary> Object type </summary> </member> <member name="F:CMS.PortalEngine.TransformationInfo.EXTERNAL_COLUMN_CODE"> <summary> External column name for Transformation Code </summary> </member> <member name="F:CMS.PortalEngine.TransformationInfo.EXTERNAL_COLUMN_CSS"> <summary> External column name for Transformation CSS </summary> </member> <member name="F:CMS.PortalEngine.TransformationInfo.TYPEINFO"> <summary> Type information. </summary> </member> <member name="M:CMS.PortalEngine.TransformationInfo.GetPreferredPreviewDocument"> <summary> Returns transformation preferred document array (alias path,site ID, culturecode) </summary> </member> <member name="M:CMS.PortalEngine.TransformationInfo.DeleteObject"> <summary> Deletes the object using appropriate provider. </summary> </member> <member name="M:CMS.PortalEngine.TransformationInfo.SetObject"> <summary> Updates the object using appropriate provider. </summary> </member> <member name="M:CMS.PortalEngine.TransformationInfo.GetVirtualFileRelativePath(System.String,System.String)"> <summary> Returns virtual relative path for specific column </summary> <param name="externalColumnName">External column name</param> <param name="versionGuid">Version GUID. If not defined physical path is generated</param> </member> <member name="M:CMS.PortalEngine.TransformationInfo.RegisterExternalColumns"> <summary> Returns path to externally stored transformation codes. </summary> </member> <member name="M:CMS.PortalEngine.TransformationInfo.#ctor"> <summary> Constructor, creates an empty TransformationInfo structure. </summary> </member> <member name="M:CMS.PortalEngine.TransformationInfo.#ctor(System.Data.DataRow)"> <summary> Constructor, creates the TransformationInfo object from the given DataRow data. </summary> <param name="dr">Data row with the TransformationInfo info data</param> </member> <member name="M:CMS.PortalEngine.TransformationInfo.LoadDefaultData"> <summary> Loads the object default data </summary> </member> <member name="M:CMS.PortalEngine.TransformationInfo.GetThemePath"> <summary> Gets the theme path for the object </summary> </member> <member name="M:CMS.PortalEngine.TransformationInfo.GetPermissionName(CMS.DataEngine.PermissionsEnum)"> <summary> Converts PermissionEnum to permission codename which will be checked when CheckPermission() is called. </summary> <param name="permission">Permission to convert to string</param> </member> <member name="M:CMS.PortalEngine.TransformationInfo.CheckPermissionsInternal(CMS.DataEngine.PermissionsEnum,System.String,CMS.Base.IUserInfo,System.Boolean)"> <summary> Checks the permissions of the object. </summary> <param name="permission">Permission type</param> <param name="siteName">Name of the site</param> <param name="userInfo">UserInfo object</param> <param name="exceptionOnFailure">If true, PermissionCheckException is thrown whenever a permission check fails</param> </member> <member name="M:CMS.PortalEngine.TransformationInfo.InsertAsCloneInternal(CMS.DataEngine.CloneSettings,CMS.DataEngine.CloneResult,CMS.DataEngine.BaseInfo)"> <summary> Inserts cloned object to DB. </summary> <param name="settings">Cloning settings</param> <param name="result">Cloning result</param> <param name="originalObject">Original source BaseInfo (object being cloned)</param> </member> <member name="P:CMS.PortalEngine.TransformationInfo.TransformationID"> <summary> Transformation ID. </summary> </member> <member name="P:CMS.PortalEngine.TransformationInfo.TransformationName"> <summary> Transformation Name. </summary> </member> <member name="P:CMS.PortalEngine.TransformationInfo.TransformationFullName"> <summary> Transformation Full Name. </summary> </member> <member name="P:CMS.PortalEngine.TransformationInfo.ObjectFullName"> <summary> Object full name if defined </summary> </member> <member name="P:CMS.PortalEngine.TransformationInfo.TransformationPreferredDocument"> <summary> Preferred document for transformation preview. Format aliaspath;siteID;culturecode </summary> </member> <member name="P:CMS.PortalEngine.TransformationInfo.TransformationCode"> <summary> Transformation Code. </summary> </member> <member name="P:CMS.PortalEngine.TransformationInfo.TransformationCSS"> <summary> Transformation CSS. </summary> </member> <member name="P:CMS.PortalEngine.TransformationInfo.TransformationType"> <summary> Transformation type. </summary> </member> <member name="P:CMS.PortalEngine.TransformationInfo.TransformationClassID"> <summary> ID of the class. </summary> </member> <member name="P:CMS.PortalEngine.TransformationInfo.TransformationVersionGUID"> <summary> Transformation version GUID. </summary> </member> <member name="P:CMS.PortalEngine.TransformationInfo.TransformationLastModified"> <summary> Transformation last modified. </summary> </member> <member name="P:CMS.PortalEngine.TransformationInfo.TransformationGUID"> <summary> Transformation GUID. </summary> </member> <member name="P:CMS.PortalEngine.TransformationInfo.TransformationIsHierarchical"> <summary> Indicates whether this transformation is hierarchical. </summary> </member> <member name="P:CMS.PortalEngine.TransformationInfo.TransformationHierarchicalXML"> <summary> Definition of all hierarchical transformations. </summary> </member> <member name="P:CMS.PortalEngine.TransformationInfo.TransformationHierarchicalXMLDocument"> <summary> Gets the hierarchical transformation XML Document object. </summary> </member> <member name="P:CMS.PortalEngine.TransformationInfo.UsesExternalStorage"> <summary> Indicates whether the theme path points at an external storage. </summary> </member> <member name="P:CMS.PortalEngine.TransformationInfo.EditDeleteButtonsMode"> <summary> Indicates whether edit delete buttons should be used within the processing of transformation </summary> </member> <member name="T:CMS.PortalEngine.TransformationInfoProvider"> <summary> Enables access to Transformations. </summary> </member> <member name="M:CMS.PortalEngine.TransformationInfoProvider.#ctor"> <summary> Initializes a TransformationInfoProvider. </summary> </member> <member name="F:CMS.PortalEngine.TransformationInfoProvider.mDefaultNamespaces"> <summary> List of default transformation namespaces </summary> </member> <member name="F:CMS.PortalEngine.TransformationInfoProvider.mTransformationDirectives"> <summary> Public transformation directives. </summary> </member> <member name="M:CMS.PortalEngine.TransformationInfoProvider.GetVirtualObject(System.String)"> <summary> Returns web part layout info for specified path </summary> <param name="path">Path</param> </member> <member name="M:CMS.PortalEngine.TransformationInfoProvider.RemoveDirectives(System.String)"> <summary> Removes the transformation directives. </summary> <param name="code">Input code</param> </member> <member name="M:CMS.PortalEngine.TransformationInfoProvider.GetTransformation(System.Int32)"> <summary> Gets the transformation by ID. </summary> <param name="transformationId">Transformation ID</param> </member> <member name="M:CMS.PortalEngine.TransformationInfoProvider.GetTransformation(System.String)"> <summary> Gets the transformation by full name. </summary> <param name="transformationFullName">Transformation full name in format application.class.transformation</param> </member> <member name="M:CMS.PortalEngine.TransformationInfoProvider.GetLocalizedTransformation(System.String,System.String)"> <summary> Gets the localized transformation by full name. Returns the default transformation if the localized version is not found. </summary> <param name="transformationFullName">Transformation full name in format application.class.transformation</param> <param name="cultureCode">Culture code</param> </member> <member name="M:CMS.PortalEngine.TransformationInfoProvider.GetTransformations"> <summary> Returns all transformations. </summary> </member> <member name="M:CMS.PortalEngine.TransformationInfoProvider.GetTransformations(System.Int32)"> <summary> Gets the transformations of the specified class. </summary> <param name="classId">Class ID</param> </member> <member name="M:CMS.PortalEngine.TransformationInfoProvider.GetTransformationFullName(System.Int32)"> <summary> Returns full transformation name by provided transformation ID. </summary> <param name="transformationId">Transformation ID</param> <returns>Transformation full name in format application.class.transformation or null.</returns> </member> <member name="M:CMS.PortalEngine.TransformationInfoProvider.SetTransformation(CMS.PortalEngine.TransformationInfo)"> <summary> Saves the specified transformation to the database. </summary> <param name="transformation">Transformation</param> <remarks>If the transformation of the specified name already exists, it's updated, otherwise a new one is created in the database.</remarks> </member> <member name="M:CMS.PortalEngine.TransformationInfoProvider.DeleteTransformation(System.Int32)"> <summary> Deletes the transformation. </summary> <param name="transformationId">Transformation ID</param> </member> <member name="M:CMS.PortalEngine.TransformationInfoProvider.DeleteTransformation(CMS.PortalEngine.TransformationInfo)"> <summary> Deletes the transformation. </summary> <param name="transformation">Transformation</param> </member> <member name="M:CMS.PortalEngine.TransformationInfoProvider.DeleteTransformations(System.Int32)"> <summary> Deletes all the transformations of the specified class. </summary> <param name="classId">Class ID</param> </member> <member name="M:CMS.PortalEngine.TransformationInfoProvider.Clear(System.Boolean)"> <summary> Clears the hashtables. </summary> <param name="logTasks">If true, the web farm tasks are logged</param> </member> <member name="M:CMS.PortalEngine.TransformationInfoProvider.GenerateTransformationCode(System.String,CMS.PortalEngine.TransformationTypeEnum,CMS.PortalEngine.DefaultTransformationTypeEnum)"> <summary> Generates the default transformation code for given class. </summary> <param name="className">Class name</param> <param name="transformationType">Type of the transformation to be generated.</param> <param name="defaultTransformationType">Default transformation type for the ASCX transformation.</param> </member> <member name="M:CMS.PortalEngine.TransformationInfoProvider.GetEditDeleteCode(System.Boolean,System.Boolean,CMS.PortalEngine.EditModeButtonEnum)"> <summary> Gets the aspx code for edit delete buttons </summary> <param name="addedAutomatically">Indicates whether directive was added automatically</param> <param name="addedByMacro">Indicates whether directive was added by macro</param> <param name="mode">Edit buttons mode</param> </member> <member name="M:CMS.PortalEngine.TransformationInfoProvider.AddTransformationDirectives(System.String,System.Boolean,CMS.PortalEngine.EditModeButtonEnum,CMS.PortalEngine.TransformationTypeEnum)"> <summary> Adds the layout directives to the transformation. </summary> <param name="code">Code</param> <param name="useInternal">If true, internal directives are used</param> <param name="mode">Indicates which mode for 'edit/delete buttons' should be used</param> <param name="type">Type of the transformation</param> </member> <member name="M:CMS.PortalEngine.TransformationInfoProvider.AddTransformationDirectives(System.String,System.Boolean,CMS.PortalEngine.EditModeButtonEnum)"> <summary> Adds the transformation directives to the transformation. </summary> <param name="code">Code</param> <param name="useInternal">If true, internal directives are used</param> <param name="mode">Indicates which mode for 'edit/delete buttons' should be used</param> </member> <member name="M:CMS.PortalEngine.TransformationInfoProvider.RemoveFirstPart(System.String,System.String)"> <summary> Returns the string with first selector removed. </summary> <param name="expression">Expression</param> <param name="delimiter">Selector delimiter</param> </member> <member name="M:CMS.PortalEngine.TransformationInfoProvider.GetTransformationsInternal"> <summary> Returns all transformations. </summary> </member> <member name="M:CMS.PortalEngine.TransformationInfoProvider.GetTransformationInfoInternal(System.Int32)"> <summary> Gets the transformation by ID. </summary> <param name="transformationId">Transformation ID</param> </member> <member name="M:CMS.PortalEngine.TransformationInfoProvider.GetTransformationInfoInternal(System.String)"> <summary> Gets the transformation by full name. </summary> <param name="transformationFullName">Transformation full name</param> </member> <member name="M:CMS.PortalEngine.TransformationInfoProvider.SetTransformationInfoInternal(CMS.PortalEngine.TransformationInfo)"> <summary> Sets the transformation to the database. </summary> <param name="transformation">Transformation</param> <exception cref="T:System.InvalidOperationException">Thrown when <see cref="P:CMS.PortalEngine.TransformationInfo.TransformationName"/> is not set or is not in correct format.</exception> </member> <member name="M:CMS.PortalEngine.TransformationInfoProvider.DeleteTransformationInfoInternal(CMS.PortalEngine.TransformationInfo)"> <summary> Deletes the specified transformation. </summary> <param name="transformation">Transformation</param> </member> <member name="M:CMS.PortalEngine.TransformationInfoProvider.GetFullNameDictionary"> <summary> Creates a new dictionary for caching the transformations by the full name. </summary> </member> <member name="M:CMS.PortalEngine.TransformationInfoProvider.GetFullNameWhereCondition(System.String)"> <summary> Gets the where condition that searches the transformation based on the given full name. </summary> <param name="fullName">Transformation full name</param> </member> <member name="M:CMS.PortalEngine.TransformationInfoProvider.GetControlDirective"> <summary> Gets the control directive for the transformation. </summary> </member> <member name="M:CMS.PortalEngine.TransformationInfoProvider.GetNamespaceRegistration(System.String,System.String,System.String)"> <summary> Gets the registration tag for the given namespace and assembly. </summary> <param name="tagPrefix">Tag prefix</param> <param name="ns">Namespace name</param> <param name="assembly">Assembly name</param> </member> <member name="M:CMS.PortalEngine.TransformationInfoProvider.GetXSLTransformation(System.String)"> <summary> Returns default XSL transformation based on the given form. </summary> <param name="formSchema">Form schema</param> <returns>XSL transformation</returns> </member> <member name="M:CMS.PortalEngine.TransformationInfoProvider.GetTextTransformation(System.String)"> <summary> Returns default text transformation based on the given form. </summary> <param name="formSchema">Form schema</param> <returns>Text transformation</returns> </member> <member name="M:CMS.PortalEngine.TransformationInfoProvider.GetASCXTransformation(System.String)"> <summary> Returns default ASCX transformation based on the given form. </summary> <param name="formSchema">Form schema</param> <returns>ASCX transformation</returns> </member> <member name="M:CMS.PortalEngine.TransformationInfoProvider.GetJQueryTransformation(System.String)"> <summary> Returns default jQuery transformation based on the given form. </summary> <param name="formSchema">Form schema</param> <returns>jQuery transformation</returns> </member> <member name="M:CMS.PortalEngine.TransformationInfoProvider.GetRSSTransformation(CMS.DataEngine.DataClassInfo)"> <summary> Returns default RSS transformation. </summary> <param name="classInfo">Class</param> <returns>RSS transformation</returns> </member> <member name="M:CMS.PortalEngine.TransformationInfoProvider.GetAtomTransformation(CMS.DataEngine.DataClassInfo)"> <summary> Returns default Atom transformation. </summary> <param name="classInfo">Class info</param> <returns>Atom transformation</returns> </member> <member name="M:CMS.PortalEngine.TransformationInfoProvider.GetXMLTransformation(System.String,System.String)"> <summary> Returns default XML transformation based on the given form. </summary> <param name="formSchema">Form schema</param> <param name="className">Class name</param> <returns>XML transformation</returns> </member> <member name="P:CMS.PortalEngine.TransformationInfoProvider.TransformationBaseClass"> <summary> Gets or sets the transformation base class </summary> </member> <member name="P:CMS.PortalEngine.TransformationInfoProvider.StoreTransformationsInExternalStorage"> <summary> Gets or sets the value that indicates whether transformations should be stored externally </summary> </member> <member name="P:CMS.PortalEngine.TransformationInfoProvider.EditButtonsDirectiveRegex"> <summary> Gets the regular expression for edit buttons directive </summary> </member> <member name="P:CMS.PortalEngine.TransformationInfoProvider.EditButtonsRegex"> <summary> Gets the Regex object for edit/delete buttons macro </summary> </member> <member name="P:CMS.PortalEngine.TransformationInfoProvider.DefaultDirectives"> <summary> Default transformation directives made into an array. </summary> </member> <member name="P:CMS.PortalEngine.TransformationInfoProvider.TransformationDirectives"> <summary> Transformation directives. </summary> </member> <member name="P:CMS.PortalEngine.TransformationInfoProvider.InternalTransformationDirectives"> <summary> Internal transformation directives. </summary> </member> <member name="P:CMS.PortalEngine.TransformationInfoProvider.TransformationsDirectory"> <summary> TransformationsDirectory - Read only </summary> </member> <member name="P:CMS.PortalEngine.TransformationInfoProvider.DefaultNamespaces"> <summary> List of default transformation namespaces </summary> </member> <member name="T:CMS.PortalEngine.TransformationTypeEnum"> <summary> Transformation type enumeration. </summary> </member> <member name="F:CMS.PortalEngine.TransformationTypeEnum.Ascx"> <summary> ASCX transformation (for user controls). </summary> </member> <member name="F:CMS.PortalEngine.TransformationTypeEnum.Xslt"> <summary> XSL transformation. </summary> </member> <member name="F:CMS.PortalEngine.TransformationTypeEnum.Text"> <summary> General text transformation (with resolved macros). </summary> </member> <member name="F:CMS.PortalEngine.TransformationTypeEnum.Html"> <summary> Html transformation (with resolved macros and WYSIWYG editing). </summary> </member> <member name="F:CMS.PortalEngine.TransformationTypeEnum.jQuery"> <summary> jQuery transformation (with resolved macros) </summary> </member> <member name="T:CMS.PortalEngine.TransformationVirtualFileObject"> <summary> Transformation virtual file object </summary> </member> <member name="M:CMS.PortalEngine.TransformationVirtualFileObject.#ctor(System.String,CMS.PortalEngine.TransformationInfo)"> <summary> Constructor </summary> <param name="virtualPath">Virtual path</param> <param name="currentObject">Object instance</param> </member> <member name="M:CMS.PortalEngine.TransformationVirtualFileObject.GetVirtualFileObject(System.String)"> <summary> Creates IVirtualFileObject for specified virtual path (GetVirtualFileObjectHandler callback method) </summary> <param name="virtualPath">Virtual path</param> </member> <member name="P:CMS.PortalEngine.TransformationVirtualFileObject.Content"> <summary> Gets virtual file content for current object </summary> </member> <member name="P:CMS.PortalEngine.TransformationVirtualFileObject.IsStoredExternally"> <summary> Indicates whether file content is stored externally (e.g. file system) </summary> </member> <member name="P:CMS.PortalEngine.TransformationVirtualFileObject.ObjectHash"> <summary> Gets object hash string used for identification of compiled version in .NET cache </summary> </member> <member name="P:CMS.PortalEngine.TransformationVirtualFileObject.PhysicalFilePath"> <summary> Gets the physical file path if exists </summary> </member> <member name="P:CMS.PortalEngine.TransformationVirtualFileObject.VirtualPath"> <summary> Current object virtual path </summary> </member> <member name="P:CMS.PortalEngine.TransformationVirtualFileObject.CurrentObject"> <summary> Current object instance </summary> </member> <member name="T:CMS.PortalEngine.UIElementPropertiesPosition"> <summary> Web part properties position enumeration. </summary> </member> <member name="F:CMS.PortalEngine.UIElementPropertiesPosition.Before"> <summary> Before custom properties. </summary> </member> <member name="F:CMS.PortalEngine.UIElementPropertiesPosition.After"> <summary> After custom properties. </summary> </member> <member name="F:CMS.PortalEngine.UIElementPropertiesPosition.Both"> <summary> Both </summary> </member> <member name="T:CMS.PortalEngine.VariantSettings"> <summary> Container for shared settings used by operations with variants. </summary> </member> <member name="P:CMS.PortalEngine.VariantSettings.ID"> <summary> The variant id </summary> </member> <member name="P:CMS.PortalEngine.VariantSettings.Name"> <summary> Name of the variant </summary> </member> <member name="P:CMS.PortalEngine.VariantSettings.DisplayName"> <summary> Display name of the variant </summary> </member> <member name="P:CMS.PortalEngine.VariantSettings.Description"> <summary> The variant description </summary> </member> <member name="P:CMS.PortalEngine.VariantSettings.Enabled"> <summary> Indicates whether the variant is enabled </summary> </member> <member name="P:CMS.PortalEngine.VariantSettings.Condition"> <summary> The condition under variant is shown. </summary> </member> <member name="P:CMS.PortalEngine.VariantSettings.ZoneID"> <summary> The zone id </summary> </member> <member name="P:CMS.PortalEngine.VariantSettings.InstanceGuid"> <summary> The web part instance GUID (Guid.Empty for zone variant) </summary> </member> <member name="P:CMS.PortalEngine.VariantSettings.PageTemplateID"> <summary> The page template id </summary> </member> <member name="P:CMS.PortalEngine.VariantSettings.DocumentID"> <summary> The document id </summary> </member> <member name="T:CMS.PortalEngine.ViewModeCode"> <summary> Page mode code. </summary> </member> <member name="M:CMS.PortalEngine.ViewModeCode.GetPageEnumFromString(System.String)"> <summary> Gets the view mode enumeration from the string value. Supports only page view modes </summary> <param name="viewMode">View mode</param> </member> <member name="M:CMS.PortalEngine.ViewModeCode.ToEnum(System.Int32)"> <summary> Returns the enumeration representation of the Page mode code. </summary> <param name="code">View mode code</param> </member> <member name="M:CMS.PortalEngine.ViewModeCode.FromEnum(CMS.PortalEngine.ViewModeEnum)"> <summary> Returns the page mode code from the enumeration value. </summary> <param name="value">Value to convert</param> </member> <member name="M:CMS.PortalEngine.ViewModeCode.FromString(System.String)"> <summary> Gets the view mode enumeration from the given string </summary> <param name="mode">String mode to convert</param> </member> <member name="M:CMS.PortalEngine.ViewModeCode.IsSubsetOfEditMode(CMS.PortalEngine.ViewModeEnum)"> <summary> Returns TRUE if given mode is subset of 'Edit' mode. </summary> <param name="mode">Mode to evaluate</param> </member> <member name="T:CMS.PortalEngine.ViewModeExtensions"> <summary> Extensions for the view mode enum </summary> </member> <member name="M:CMS.PortalEngine.ViewModeExtensions.IsPreview(CMS.PortalEngine.ViewModeEnum)"> <summary> Returns true if the view mode is preview view mode </summary> <param name="viewMode">View mode to check</param> </member> <member name="M:CMS.PortalEngine.ViewModeExtensions.IsEditLive(CMS.PortalEngine.ViewModeEnum)"> <summary> Returns true if the view mode is editing view mode for live site </summary> <param name="viewMode">View mode to check</param> </member> <member name="M:CMS.PortalEngine.ViewModeExtensions.IsDesign(CMS.PortalEngine.ViewModeEnum,System.Boolean)"> <summary> Returns true if the view mode is design view mode </summary> <param name="viewMode">View mode to check</param> <param name="includeDesignDisabled">if set to <c>true</c> returns <c>true</c> for DesignDisabled as well.</param> </member> <member name="M:CMS.PortalEngine.ViewModeExtensions.IsEdit(CMS.PortalEngine.ViewModeEnum,System.Boolean)"> <summary> Returns true if the view mode is editing view mode </summary> <param name="viewMode">View mode to check</param> <param name="includeEditDisabled">if set to <c>true</c> returns <c>true</c> for EditDisabled as well.</param> </member> <member name="M:CMS.PortalEngine.ViewModeExtensions.IsLiveSite(CMS.PortalEngine.ViewModeEnum)"> <summary> Returns true if the view mode is live site view mode </summary> <param name="viewMode">View mode to check</param> </member> <member name="M:CMS.PortalEngine.ViewModeExtensions.IsOneOf(CMS.PortalEngine.ViewModeEnum,CMS.PortalEngine.ViewModeEnum[])"> <summary> Returns true if the view mode is one of the given view modes </summary> <param name="viewMode">View mode to check</param> <param name="modes">View modes to match</param> </member> <member name="T:CMS.PortalEngine.ViewModeOnDemand"> <summary> Encapsulates the view mode but doesn't request it until it is demanded by Value. </summary> </member> <member name="M:CMS.PortalEngine.ViewModeOnDemand.op_Implicit(CMS.PortalEngine.ViewModeOnDemand)~CMS.PortalEngine.ViewModeEnum"> <summary> Converts the view mode to its enum representation </summary> <param name="viewMode">View mode</param> </member> <member name="M:CMS.PortalEngine.ViewModeOnDemand.IsLiveSite"> <summary> Returns true if the view mode is live site mode </summary> </member> <member name="P:CMS.PortalEngine.ViewModeOnDemand.Value"> <summary> Value. </summary> </member> <member name="T:CMS.PortalEngine.IWebPartZoneProperties"> <summary> Interface for webpart zone properties control </summary> </member> <member name="M:CMS.PortalEngine.IWebPartZoneProperties.Save"> <summary> Saves the object </summary> </member> <member name="T:CMS.PortalEngine.PortalContext"> <summary> Portal context methods. </summary> </member> <member name="M:CMS.PortalEngine.PortalContext.EnsurePortalMode(CMS.PortalEngine.ViewModeEnum)"> <summary> Ensures the portal mode. </summary> </member> <member name="M:CMS.PortalEngine.PortalContext.IsPortalMode(CMS.PortalEngine.ViewModeEnum)"> <summary> Returns true if the given mode is mode displaying the document. </summary> </member> <member name="M:CMS.PortalEngine.PortalContext.GetViewMode"> <summary> Gets current view mode. </summary> </member> <member name="M:CMS.PortalEngine.PortalContext.SetRequestViewMode(CMS.PortalEngine.ViewModeEnum)"> <summary> Sets current request view mode. </summary> <param name="value">New view mode</param> </member> <member name="M:CMS.PortalEngine.PortalContext.SetViewMode(CMS.PortalEngine.ViewModeEnum)"> <summary> Sets current view mode. </summary> <param name="value">New view mode</param> </member> <member name="M:CMS.PortalEngine.PortalContext.UpdateViewMode(CMS.PortalEngine.ViewModeEnum)"> <summary> Updates the current view mode </summary> <param name="baseMode">Current base mode (edit / preview / live)</param> </member> <member name="M:CMS.PortalEngine.PortalContext.IsDesignMode(CMS.PortalEngine.ViewModeEnum,System.Boolean)"> <summary> Returns true if the given mode is considered design mode (with web parts active) </summary> <param name="mode">View mode to check</param> <param name="allowDisabled">If true (default), the disabled design view mode is detected as design mode</param> </member> <member name="M:CMS.PortalEngine.PortalContext.GetEditorWidgetsKey(System.Int32)"> <summary> Gets the unique identifier for editor widgets per document. </summary> <param name="documentId">The document id.</param> </member> <member name="M:CMS.PortalEngine.PortalContext.GetEditorWidgets(System.Int32)"> <summary> Gets modified editor widgets from a temporary interlayer. </summary> <param name="documentId">The document id.</param> </member> <member name="M:CMS.PortalEngine.PortalContext.SaveEditorWidgets(System.Int32,System.String)"> <summary> Saves the modified editor widgets into a temporary interlayer. </summary> <param name="documentId">The document id.</param> <param name="widgets">The widgets.</param> </member> <member name="M:CMS.PortalEngine.PortalContext.ClearEditorWidgets(System.Int32)"> <summary> Clears the temporary interlayer which holds modified editor widgets. </summary> <param name="documentId">The document id.</param> </member> <member name="P:CMS.PortalEngine.PortalContext.CurrentCompiledValue"> <summary> Gets or sets the current compiled value of css pre-processor </summary> </member> <member name="P:CMS.PortalEngine.PortalContext.CurrentEditableControls"> <summary> Gets the list of editable controls on current page. </summary> </member> <member name="P:CMS.PortalEngine.PortalContext.CurrentPageManager"> <summary> Gets or sets the current page manager </summary> </member> <member name="P:CMS.PortalEngine.PortalContext.EditDeleteButtonsMode"> <summary> Gets or sets the edit/delete buttons mode </summary> </member> <member name="P:CMS.PortalEngine.PortalContext.ViewMode"> <summary> Returns current ViewMode. </summary> </member> <member name="P:CMS.PortalEngine.PortalContext.DashboardName"> <summary> Gets or sets the current dashboard name. </summary> </member> <member name="P:CMS.PortalEngine.PortalContext.DashboardSiteName"> <summary> Gets or sets the current dashboard site name. </summary> </member> <member name="P:CMS.PortalEngine.PortalContext.CurrentComponents"> <summary> List of web part containers used by current page. Hashtable [containerName.ToLowerCSafe() -> WebPartContainerInfo] </summary> </member> <member name="P:CMS.PortalEngine.PortalContext.MVTVariantsEnabled"> <summary> Indicates whether to show the MVT variant slider and render all the web part/zone variants. This value will be true only when there are defined any multivariate tests for the current document. </summary> </member> <member name="P:CMS.PortalEngine.PortalContext.EditableControlsHidden"> <summary> Gets or sets the value that indicates whether current page may contain some hidden editable controls </summary> </member> <member name="P:CMS.PortalEngine.PortalContext.ContentPersonalizationVariantsEnabled"> <summary> Gets or sets the value that indicates whether current page has at least one personalization variant </summary> </member> <member name="P:CMS.PortalEngine.PortalContext.ContentPersonalizationEnabled"> <summary> Indicates whether to show the Content personalization variant slider and render all the web part/zone variants. </summary> </member> <member name="P:CMS.PortalEngine.PortalContext.CurrentSiteStylesheet"> <summary> Returns the current site stylesheet info. </summary> </member> <member name="P:CMS.PortalEngine.PortalContext.CurrentSiteStylesheetName"> <summary> Returns current site stylesheet name. </summary> </member> <member name="P:CMS.PortalEngine.PortalContext.CurrentUserIsDesigner"> <summary> Indicates whether the current user has designer rights and can access web part properties (UI element) </summary> </member> <member name="T:CMS.PortalEngine.ViewModeEnum"> <summary> Page mode enumeration. </summary> </member> <member name="F:CMS.PortalEngine.ViewModeEnum.LiveSite"> <summary> Live site mode. </summary> </member> <member name="F:CMS.PortalEngine.ViewModeEnum.Preview"> <summary> Preview mode. </summary> </member> <member name="F:CMS.PortalEngine.ViewModeEnum.Edit"> <summary> Edit mode - content editing. </summary> </member> <member name="F:CMS.PortalEngine.ViewModeEnum.Design"> <summary> Edit mode with disabled controls - when not authorized or cannot edit. </summary> </member> <member name="F:CMS.PortalEngine.ViewModeEnum.EditForm"> <summary> Edit form mode - for portal engine pages. </summary> </member> <member name="F:CMS.PortalEngine.ViewModeEnum.Unknown"> <summary> Unknown / does not matter </summary> </member> <member name="F:CMS.PortalEngine.ViewModeEnum.EditLive"> <summary> On-Site edit mode </summary> </member> <member name="F:CMS.PortalEngine.ViewModeEnum.Listing"> <summary> Listing mode. </summary> </member> <member name="F:CMS.PortalEngine.ViewModeEnum.SectionEdit"> <summary> Section edit mode. </summary> </member> <member name="F:CMS.PortalEngine.ViewModeEnum.UI"> <summary> UI Page </summary> </member> <member name="F:CMS.PortalEngine.ViewModeEnum.DesignWebPart"> <summary> Design mode for web parts </summary> </member> <member name="F:CMS.PortalEngine.ViewModeEnum.EditDisabled"> <summary> Edit mode - content editing (editing disabled). </summary> </member> <member name="F:CMS.PortalEngine.ViewModeEnum.EditNotCurrent"> <summary> Edit mode - not current page. </summary> </member> <member name="F:CMS.PortalEngine.ViewModeEnum.DesignDisabled"> <summary> Design mode with disabled controls - for portal engine pages. </summary> </member> <member name="F:CMS.PortalEngine.ViewModeEnum.UserWidgets"> <summary> User widgets mode. </summary> </member> <member name="F:CMS.PortalEngine.ViewModeEnum.UserWidgetsDisabled"> <summary> User widgets mode with disabled functionality (for preview mode). </summary> </member> <member name="F:CMS.PortalEngine.ViewModeEnum.GroupWidgets"> <summary> Group widgets mode. </summary> </member> <member name="F:CMS.PortalEngine.ViewModeEnum.DashboardWidgets"> <summary> Dashboard widgets mode. </summary> </member> <member name="T:CMS.PortalEngine.PageTemplateCategoryInfo"> <summary> Page template category info data container class. </summary> </member> <member name="F:CMS.PortalEngine.PageTemplateCategoryInfo.OBJECT_TYPE"> <summary> Object type </summary> </member> <member name="F:CMS.PortalEngine.PageTemplateCategoryInfo.TYPEINFO"> <summary> Type information. </summary> </member> <member name="M:CMS.PortalEngine.PageTemplateCategoryInfo.DeleteObject"> <summary> Deletes the object using appropriate provider. </summary> </member> <member name="M:CMS.PortalEngine.PageTemplateCategoryInfo.SetObject"> <summary> Updates the object using appropriate provider. </summary> </member> <member name="M:CMS.PortalEngine.PageTemplateCategoryInfo.#ctor"> <summary> Constructor - Creates an empty PageTemplateCategoryInfo object. </summary> </member> <member name="M:CMS.PortalEngine.PageTemplateCategoryInfo.#ctor(System.Data.DataRow)"> <summary> Constructor - Creates a new PageTemplateCategoryInfo object from the given DataRow. </summary> </member> <member name="M:CMS.PortalEngine.PageTemplateCategoryInfo.RemoveObjectDependencies(System.Boolean,System.Boolean)"> <summary> Removes object dependencies. </summary> </member> <member name="M:CMS.PortalEngine.PageTemplateCategoryInfo.GetDefaultDataWhereCondition(System.Boolean,System.Boolean,System.Collections.Generic.IEnumerable{System.String})"> <summary> Gets the where condition to filter out the default installation data </summary> <param name="recursive">Indicates whether where condition should contain further dependency conditions.</param> <param name="globalOnly">Indicates whether only objects with null in their site ID column should be included.</param> <param name="excludedNames">Objects with display names and code names starting with these expressions are filtered out.</param> </member> <member name="P:CMS.PortalEngine.PageTemplateCategoryInfo.CategoryId"> <summary> Gets or sets the category ID. </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateCategoryInfo.DisplayName"> <summary> Gets or sets the category display name. </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateCategoryInfo.ParentId"> <summary> Gets or sets the category parent id. </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateCategoryInfo.CategoryName"> <summary> Gets or sets the category code name. </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateCategoryInfo.PageTemplateCategoryGUID"> <summary> Page template category GUID. </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateCategoryInfo.PageTemplateCategoryLastModified"> <summary> Object last modified. </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateCategoryInfo.CategoryImagePath"> <summary> Gets or sets category image path. </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateCategoryInfo.CategoryChildCount"> <summary> Gets or sets count of child page template categories. </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateCategoryInfo.CategoryTemplateChildCount"> <summary> Gets or sets count of child page templates. </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateCategoryInfo.CategoryPath"> <summary> Gets or sets category path. </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateCategoryInfo.CategoryLevel"> <summary> Gets or sets category level. </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateCategoryInfo.ValidateCodeName"> <summary> If true, the code name is validated upon saving. </summary> </member> <member name="T:CMS.PortalEngine.PageTemplateCategoryInfoProvider"> <summary> Provides access to information about page template categories. </summary> </member> <member name="M:CMS.PortalEngine.PageTemplateCategoryInfoProvider.GetPageTemplateCategoryInfoByGUID(System.Guid)"> <summary> Returns object with specified GUID. </summary> <param name="guid">Object GUID</param> </member> <member name="M:CMS.PortalEngine.PageTemplateCategoryInfoProvider.SetPageTemplateCategoryInfo(CMS.PortalEngine.PageTemplateCategoryInfo)"> <summary> Sets the specified page template category data from info object to DB. </summary> <param name="pageTemplateCategory">Page template data object</param> </member> <member name="M:CMS.PortalEngine.PageTemplateCategoryInfoProvider.GetPageTemplateCategoryInfo(System.Int32)"> <summary> Returns the PageTemplateCategoryInfo structure for the specified CategoryId. </summary> <param name="pageTemplateCategoryId">Page CategoryID to use for retrieving the resource data</param> </member> <member name="M:CMS.PortalEngine.PageTemplateCategoryInfoProvider.GetPageTemplateCategoryInfo(System.String)"> <summary> Returns the PageTemplateCategoryInfo structure for the specified CategoryDisplayName. </summary> <param name="pageTemplateCategoryName">Category code name to use for retrieving the resource data</param> </member> <member name="M:CMS.PortalEngine.PageTemplateCategoryInfoProvider.GetPageTemplateCategoryInfoByCodeName(System.String)"> <summary> Returns the PageTemplateCategory structure by the code name. </summary> <param name="categoryName">Category code name</param> </member> <member name="M:CMS.PortalEngine.PageTemplateCategoryInfoProvider.GetPageTemplateCategories"> <summary> Returns all page template categories. </summary> </member> <member name="M:CMS.PortalEngine.PageTemplateCategoryInfoProvider.GetDescendantCategories(System.Int32)"> <summary> Returns list of categories with given ParentCategoryID. </summary> <param name="parentCategoryId">Id of parent category</param> <returns>DataSet with list of categories</returns> </member> <member name="M:CMS.PortalEngine.PageTemplateCategoryInfoProvider.DeletePageTemplateCategory(CMS.PortalEngine.PageTemplateCategoryInfo)"> <summary> Deletes template category. </summary> <param name="ptci">PageTemplateCategory object</param> </member> <member name="M:CMS.PortalEngine.PageTemplateCategoryInfoProvider.DeletePageTemplateCategory(System.Int32)"> <summary> Deletes template category defined by id. </summary> <param name="pageTemplateCategoryId">Id of category to delete</param> </member> <member name="M:CMS.PortalEngine.PageTemplateCategoryInfoProvider.GetCategoriesList(System.String,System.String)"> <summary> Returns list of all template categories with templates count. </summary> <param name="whereCondition">Where condition</param> <param name="orderBy">Order by expression</param> <returns>DataSet with list of categories</returns> </member> <member name="M:CMS.PortalEngine.PageTemplateCategoryInfoProvider.GetSiteCategoriesList(System.Int32,System.String,System.String)"> <summary> Returns list of all template categories with templates count for specific site. </summary> <param name="siteId">Site ID</param> <param name="whereCondition">Where condition</param> <param name="orderBy">Order by expression</param> <returns>DataSet with list of categories</returns> </member> <member name="M:CMS.PortalEngine.PageTemplateCategoryInfoProvider.GetCategoriesWithTemplate(System.Int32)"> <summary> Returns list of all template categories with template allowed for specified site. </summary> <param name="siteId">Site ID</param> </member> <member name="M:CMS.PortalEngine.PageTemplateCategoryInfoProvider.UpdateCategoryChildCount(System.Int32,System.Int32)"> <summary> Updates the child categories count of category. </summary> <param name="originalParentID">Original parent ID</param> <param name="newParentID">New parent ID</param> </member> <member name="M:CMS.PortalEngine.PageTemplateCategoryInfoProvider.UpdateCategoryTemplateChildCount(System.Int32,System.Int32)"> <summary> Updates the child templates count of category. </summary> <param name="originalParentID">Original parent ID</param> <param name="newParentID">New parent ID</param> </member> <member name="M:CMS.PortalEngine.PageTemplateCategoryInfoProvider.RefreshDataCounts"> <summary> Updates all counts for all sub-objects. </summary> </member> <member name="M:CMS.PortalEngine.PageTemplateCategoryInfoProvider.GetAdHocCategory"> <summary> Gets ad-hoc category info object. If category doesn't exist, creates new one. </summary> </member> <member name="M:CMS.PortalEngine.PageTemplateCategoryInfoProvider.GetAdHocUICategory"> <summary> Gets ad-hoc UI category info object. If category doesn't exist, creates new one. </summary> </member> <member name="M:CMS.PortalEngine.PageTemplateCategoryInfoProvider.GetCategoryPath(System.Int32)"> <summary> Returns the DataSet of all the categories on the path to the given category. </summary> <param name="categoryId">Category ID</param> </member> <member name="M:CMS.PortalEngine.PageTemplateCategoryInfoProvider.RefreshObjectsCounts"> <summary> Updates all counts for all sub-objects. </summary> </member> <member name="M:CMS.PortalEngine.PageTemplateCategoryInfoProvider.GetPageTemplateCategoriesInternal"> <summary> Returns all page template categories. </summary> </member> <member name="M:CMS.PortalEngine.PageTemplateCategoryInfoProvider.GetPageTemplateCategoryInfoInternal(System.Guid)"> <summary> Returns object with specified GUID. </summary> <param name="guid">Object GUID</param> </member> <member name="M:CMS.PortalEngine.PageTemplateCategoryInfoProvider.SetPageTemplateCategoryInfoInternal(CMS.PortalEngine.PageTemplateCategoryInfo)"> <summary> Sets the specified page template category data from info object to DB. </summary> <param name="pageTemplateCategory">Page template data object</param> </member> <member name="M:CMS.PortalEngine.PageTemplateCategoryInfoProvider.GetPageTemplateCategoryInfoInternal(System.Int32)"> <summary> Returns the PageTemplateCategoryInfo structure for the specified CategoryId. </summary> <param name="pageTemplateCategoryId">Page CategoryID to use for retrieving the resource data</param> </member> <member name="M:CMS.PortalEngine.PageTemplateCategoryInfoProvider.GetPageTemplateCategoryInfoInternal(System.String)"> <summary> Returns the PageTemplateCategoryInfo structure for the specified CategoryDisplayName. </summary> <param name="pageTemplateName">Category code name to use for retrieving the resource data</param> </member> <member name="M:CMS.PortalEngine.PageTemplateCategoryInfoProvider.GetDescendantCategoriesInternal(System.Int32)"> <summary> Returns list of categories with given ParentCategoryID. </summary> <param name="parentCategoryId">Id of parent category</param> <returns>DataSet with list of categories</returns> </member> <member name="M:CMS.PortalEngine.PageTemplateCategoryInfoProvider.DeletePageTemplateCategoryInternal(CMS.PortalEngine.PageTemplateCategoryInfo)"> <summary> Deletes template category. </summary> <param name="ptci">PageTemplateCategory object</param> </member> <member name="M:CMS.PortalEngine.PageTemplateCategoryInfoProvider.GetCategoriesListInternal(System.String,System.String)"> <summary> Returns list of all template categories with templates count. </summary> <param name="whereCondition">Where condition</param> <param name="orderBy">Order by expression</param> <returns>DataSet with list of categories</returns> </member> <member name="M:CMS.PortalEngine.PageTemplateCategoryInfoProvider.GetSiteCategoriesListInternal(System.Int32,System.String,System.String)"> <summary> Returns list of all template categories with templates count for specific site. </summary> <param name="siteId">Site ID</param> <param name="whereCondition">Where condition</param> <param name="orderBy">Order by expression</param> <returns>DataSet with list of categories</returns> </member> <member name="M:CMS.PortalEngine.PageTemplateCategoryInfoProvider.GetCategoriesWithTemplateInternal(System.Int32)"> <summary> Returns list of all template categories with template allowed for specified site. </summary> <param name="siteId">Site ID</param> </member> <member name="M:CMS.PortalEngine.PageTemplateCategoryInfoProvider.GetCategoryPathInternal(System.Int32)"> <summary> Returns the DataSet of all the categories on the path to the given category. </summary> <param name="categoryId">Category ID</param> </member> <member name="M:CMS.PortalEngine.PageTemplateCategoryInfoProvider.UpdateCategoryChildCountInternal(System.Int32,System.Int32)"> <summary> Updates the child categories count of category. </summary> <param name="originalParentID">Original parent ID</param> <param name="newParentID">New parent ID</param> </member> <member name="M:CMS.PortalEngine.PageTemplateCategoryInfoProvider.UpdateCategoryTemplateChildCountInternal(System.Int32,System.Int32)"> <summary> Updates the child templates count of category. </summary> <param name="originalParentID">Original parent ID</param> <param name="newParentID">New parent ID</param> </member> <member name="M:CMS.PortalEngine.PageTemplateCategoryInfoProvider.RefreshDataCountsInternal"> <summary> Updates all counts for all sub-objects. </summary> </member> <member name="M:CMS.PortalEngine.PageTemplateCategoryInfoProvider.GetAdHocCategoryInternal"> <summary> Gets ad-hoc category info object. If category doesn't exist, creates new one. </summary> </member> <member name="M:CMS.PortalEngine.PageTemplateCategoryInfoProvider.GetAdHocUICategoryInternal"> <summary> Gets ad-hoc UI category info object. If category doesn't exist, creates new one. </summary> </member> <member name="T:CMS.PortalEngine.PageTemplateInfo"> <summary> Page template info data container class. </summary> </member> <member name="F:CMS.PortalEngine.PageTemplateInfo.OBJECT_TYPE"> <summary> Object type </summary> </member> <member name="F:CMS.PortalEngine.PageTemplateInfo.EXTERNAL_COLUMN_CODE"> <summary> External column name for Layout Code </summary> </member> <member name="F:CMS.PortalEngine.PageTemplateInfo.EXTERNAL_COLUMN_CSS"> <summary> External column name for Layout CSS </summary> </member> <member name="F:CMS.PortalEngine.PageTemplateInfo.TYPEINFO"> <summary> Type information. </summary> </member> <member name="F:CMS.PortalEngine.PageTemplateInfo.mTemplateInstance"> <summary> Page template instance. </summary> </member> <member name="F:CMS.PortalEngine.PageTemplateInfo.mPageTemplatePropertiesForm"> <summary> Merged properties form info (with default XML data) </summary> </member> <member name="M:CMS.PortalEngine.PageTemplateInfo.DeleteObject"> <summary> Deletes the object using appropriate provider. </summary> </member> <member name="M:CMS.PortalEngine.PageTemplateInfo.SetObject"> <summary> Updates the object using appropriate provider. </summary> </member> <member name="M:CMS.PortalEngine.PageTemplateInfo.GetVirtualFileRelativePath(System.String,System.String)"> <summary> Returns virtual relative path for specific column </summary> <param name="externalColumnName">External column name</param> <param name="versionGuid">Version GUID. If not defined physical path is generated</param> </member> <member name="M:CMS.PortalEngine.PageTemplateInfo.RegisterExternalColumns"> <summary> Returns path to externally stored template layout codes. </summary> </member> <member name="M:CMS.PortalEngine.PageTemplateInfo.#ctor"> <summary> Constructor, creates an empty PageTemplateInfo structure. </summary> </member> <member name="M:CMS.PortalEngine.PageTemplateInfo.#ctor(System.Data.DataRow)"> <summary> Constructor, creates an empty PageTemplateInfo object from the given DataRow data. </summary> <param name="dr">Datarow with the class info data</param> </member> <member name="M:CMS.PortalEngine.PageTemplateInfo.LoadDefaultData"> <summary> Loads the object default data </summary> </member> <member name="M:CMS.PortalEngine.PageTemplateInfo.GetThemePath"> <summary> Gets the theme path for the object </summary> </member> <member name="M:CMS.PortalEngine.PageTemplateInfo.InsertAsCloneInternal(CMS.DataEngine.CloneSettings,CMS.DataEngine.CloneResult,CMS.DataEngine.BaseInfo)"> <summary> Inserts cloned object to DB. </summary> <param name="settings">Cloning settings</param> <param name="result">Cloning result</param> <param name="originalObject">Original source BaseInfo (object being cloned)</param> </member> <member name="M:CMS.PortalEngine.PageTemplateInfo.LoadTemplateUIProperties"> <summary> Loads template's UI properties </summary> </member> <member name="M:CMS.PortalEngine.PageTemplateInfo.GetPermissionName(CMS.DataEngine.PermissionsEnum)"> <summary> Converts PermissionEnum to permission codename which will be checked when CheckPermission() is called. </summary> <param name="permission">Permission to convert to string</param> </member> <member name="M:CMS.PortalEngine.PageTemplateInfo.CheckPermissionsInternal(CMS.DataEngine.PermissionsEnum,System.String,CMS.Base.IUserInfo,System.Boolean)"> <summary> Checks the permissions of the object. </summary> <param name="permission">Permission type</param> <param name="siteName">Name of the site</param> <param name="userInfo">UserInfo object</param> <param name="exceptionOnFailure">If true, PermissionCheckException is thrown whenever a permission check fails</param> </member> <member name="M:CMS.PortalEngine.PageTemplateInfo.GetChildWhereCondition(CMS.DataEngine.WhereCondition,System.String)"> <summary> Gets the child object where condition. </summary> <param name="where">Original where condition</param> <param name="objectType">Object type of the child object</param> </member> <member name="M:CMS.PortalEngine.PageTemplateInfo.GetDefaultDataWhereCondition(System.Boolean,System.Boolean,System.Collections.Generic.IEnumerable{System.String})"> <summary> Gets the where condition to filter out the default installation data </summary> <param name="recursive">Indicates whether where condition should contain further dependency conditions.</param> <param name="globalOnly">Indicates whether only objects with null in their site ID column should be included.</param> <param name="excludedNames">Objects with display names and code names starting with these expressions are filtered out.</param> </member> <member name="P:CMS.PortalEngine.PageTemplateInfo.PageTemplateAllowInheritHeader"> <summary> Indicates whether current headers can be inherited by child templates </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateInfo.PageTemplateIsLayout"> <summary> If true, page template is considered as layout </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateInfo.PageTemplatePropertiesForm"> <summary> Template's properties form (used in UI) </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateInfo.PageTemplateInheritParentHeader"> <summary> Indicates whether current template should inherit headers from parent templates </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateInfo.ParentPageInfo"> <summary> Parent page info </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateInfo.PageTemplateId"> <summary> Gets or sets the page template ID. </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateInfo.PageTemplateProperties"> <summary> UI page template properties. </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateInfo.CodeName"> <summary> Gets or sets the page template code name. </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateInfo.HasDesignMode"> <summary> Indicates whether template has design mode </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateInfo.IsThemeFolderExternal"> <summary> Indicates whether template uses external storage for themes </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateInfo.ShowTemplateASPXTab"> <summary> Indicates whether display ASPX tab </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateInfo.DisplayName"> <summary> Gets or sets the page template display name. </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateInfo.Description"> <summary> Gets or sets the page template description. </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateInfo.PageTemplateCSS"> <summary> Gets or sets the page template CSS. </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateInfo.FileName"> <summary> Gets or sets the page template filename. </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateInfo.IsPortal"> <summary> Indicates whether the <see cref="P:CMS.PortalEngine.PageTemplateInfo.PageTemplateType"/> is <see cref="F:CMS.PortalEngine.PageTemplateTypeEnum.Portal"/>. </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateInfo.PageTemplateIsAllowedForProductSection"> <summary> Gets or sets flag indicating that this template can be used for product section. </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateInfo.IsAspx"> <summary> Indicates whether the <see cref="P:CMS.PortalEngine.PageTemplateInfo.PageTemplateType"/> is <see cref="F:CMS.PortalEngine.PageTemplateTypeEnum.Aspx"/> or <see cref="F:CMS.PortalEngine.PageTemplateTypeEnum.AspxPortal"/> (mixed mode). </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateInfo.PageTemplateType"> <summary> Page template type. </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateInfo.CategoryID"> <summary> Gets or sets the page template CategoryID. </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateInfo.LayoutID"> <summary> Gets or sets the page template LayoutID. </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateInfo.WebParts"> <summary> Gets or sets the page template WebParts. </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateInfo.IsReusable"> <summary> Gets or sets flag whether page template is reusable. </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateInfo.ShowAsMasterTemplate"> <summary> Gets or sets flag whether show page template as master template. </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateInfo.InheritPageLevels"> <summary> Page levels expression that the page inherits. </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateInfo.WebPartZones"> <summary> Web part zones contained within the Page template. </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateInfo.TemplateInstance"> <summary> Template structure instance. </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateInfo.PageTemplateLayoutType"> <summary> Page template layout type. </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateInfo.PageTemplateLayout"> <summary> Page template layout. </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateInfo.PageTemplateVersionGUID"> <summary> Page template version GUID. </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateInfo.PageTemplateHeader"> <summary> Page template header. </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateInfo.PageTemplateGUID"> <summary> PageTemplate GUID. </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateInfo.PageTemplateLastModified"> <summary> Object last modified. </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateInfo.PageTemplateSiteID"> <summary> Page template site ID. </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateInfo.PageTemplateForAllPages"> <summary> Page for all pages. </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateInfo.PageTemplateThumbnailGUID"> <summary> Page template thumbnail metafile GUID. </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateInfo.PageTemplateIconClass"> <summary> Page template icon class defining the page template thumbnail. </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateInfo.PageTemplateCloneAsAdHoc"> <summary> If true, the page template is cloned as ad-hoc when selected for a new document </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateInfo.PageTemplateDefaultController"> <summary> Page template default controller (for MVC template) </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateInfo.PageTemplateDefaultAction"> <summary> Page template default action (for MVC template) </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateInfo.PageTemplateNodeGUID"> <summary> Gets or sets the page template node GUID - For Ad-hoc templates </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateInfo.PageTemplateMasterPageTemplateID"> <summary> Master page template ID of the template, if set, the page template uses this template as extra master template in the view hierarchy </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateInfo.UsesExternalStorage"> <summary> Indicates whether the theme path points at an external storage. </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateInfo.AllowRestore"> <summary> Indicates if the object supports deleting to recycle bin. </summary> </member> <member name="T:CMS.PortalEngine.PageTemplateInfoProvider"> <summary> Provides access to information about page templates. </summary> </member> <member name="F:CMS.PortalEngine.PageTemplateInfoProvider.WEBPART_TEMPLATE_STARTID"> <summary> ID from which start the virtual page templates for web parts </summary> </member> <member name="F:CMS.PortalEngine.PageTemplateInfoProvider.TEMPLATE_LAYOUTS_DIRECTORY"> <summary> Template layouts directory. </summary> </member> <member name="F:CMS.PortalEngine.PageTemplateInfoProvider.ADHOC_TEMPLATE_LAYOUTS_DIRECTORY"> <summary> Ad-hoc template layouts directory. </summary> </member> <member name="F:CMS.PortalEngine.PageTemplateInfoProvider.TEMPLATES_DIRECTORY"> <summary> Template layouts directory. </summary> </member> <member name="F:CMS.PortalEngine.PageTemplateInfoProvider.mCreateSearchTasks"> <summary> Indicates whether search task should be created if template was changed. </summary> </member> <member name="M:CMS.PortalEngine.PageTemplateInfoProvider.#ctor"> <summary> Constructor. </summary> </member> <member name="M:CMS.PortalEngine.PageTemplateInfoProvider.SetPageTemplateInfo(CMS.PortalEngine.PageTemplateInfo)"> <summary> Sets the specified page template. </summary> <param name="template">Page template object</param> </member> <member name="M:CMS.PortalEngine.PageTemplateInfoProvider.GetTemplatesInCategory(System.Int32)"> <summary> Gets all templates in specified category. </summary> <param name="categoryId">Parent category id. Use categoryId = 0 for templates under root</param> </member> <member name="M:CMS.PortalEngine.PageTemplateInfoProvider.GetPageTemplateInfo(System.String)"> <summary> Gets the page template object. </summary> <param name="templateName">Page template name</param> </member> <member name="M:CMS.PortalEngine.PageTemplateInfoProvider.GetPageTemplateInfo(System.String,System.Int32)"> <summary> Gets the page template object. </summary> <param name="templateName">Page template name</param> <param name="siteId">Site ID</param> </member> <member name="M:CMS.PortalEngine.PageTemplateInfoProvider.DeleteAdHocTemplates(System.Guid,System.Int32)"> <summary> Deletes all ad hoc templates for given node (UI element) based on it's GUID. </summary> <param name="guid">Item's guid</param> <param name="siteId">Site ID</param> </member> <member name="M:CMS.PortalEngine.PageTemplateInfoProvider.GetPageTemplateInfo(System.Int32)"> <summary> Gets the page template object. </summary> <param name="templateId">Page template ID</param> </member> <member name="M:CMS.PortalEngine.PageTemplateInfoProvider.AddPageTemplateToSite(System.Int32,System.Int32)"> <summary> Adds page template to specific site. </summary> <param name="templateId">Page template ID</param> <param name="siteId">Site ID</param> </member> <member name="M:CMS.PortalEngine.PageTemplateInfoProvider.RemovePageTemplateFromSite(System.Int32,System.Int32)"> <summary> Removes page template from site. </summary> <param name="templateId">Page template ID</param> <param name="siteId">Site ID</param> </member> <member name="M:CMS.PortalEngine.PageTemplateInfoProvider.DeletePageTemplate(CMS.PortalEngine.PageTemplateInfo)"> <summary> Deletes page template. </summary> <param name="template">Page template object</param> </member> <member name="M:CMS.PortalEngine.PageTemplateInfoProvider.DeletePageTemplate(System.Int32)"> <summary> Deletes page template with specific ID. </summary> <param name="templateId">Page template ID</param> </member> <member name="M:CMS.PortalEngine.PageTemplateInfoProvider.IsPageTemplateOnSite(System.Int32,System.Int32)"> <summary> Checks if exists relation between page template and site. </summary> <param name="templateId">Page template ID</param> <param name="siteId">Site ID</param> </member> <member name="M:CMS.PortalEngine.PageTemplateInfoProvider.PageTemplateNameExists(System.String)"> <summary> Checks whether the page template with given name already exists. </summary> <param name="templateName">Page template name</param> </member> <member name="M:CMS.PortalEngine.PageTemplateInfoProvider.PageTemplateNameExists(System.String,System.Int32)"> <summary> Checks whether the page template with given name already exists. </summary> <param name="templateName">Page template name</param> <param name="siteId">Site ID</param> </member> <member name="M:CMS.PortalEngine.PageTemplateInfoProvider.Clear(System.Boolean)"> <summary> Clears the hashtables. </summary> <param name="logTasks">Indicates if the web farm tasks should be logged</param> </member> <member name="M:CMS.PortalEngine.PageTemplateInfoProvider.GetTemplates"> <summary> Get all page templates using ObjectQuery. </summary> </member> <member name="M:CMS.PortalEngine.PageTemplateInfoProvider.GetAllowedTemplates(System.Int32)"> <summary> Gets page templates allowed for specified site. </summary> <param name="siteId">Site ID</param> </member> <member name="M:CMS.PortalEngine.PageTemplateInfoProvider.GetAllowedTemplatesInCategory(System.Int32,System.Int32)"> <summary> Gets page templates allowed for specified site. </summary> <param name="siteId">Site ID</param> <param name="categoryId">Page template category</param> </member> <member name="M:CMS.PortalEngine.PageTemplateInfoProvider.CloneTemplateAsAdHoc(CMS.PortalEngine.PageTemplateInfo,System.String,System.Int32,System.Guid)"> <summary> Gets new page template object cloned as an ad-hoc template from the given source page template info. </summary> <param name="sourceInfo">Source page template info</param> <param name="displayName">Cloned page template display name</param> <param name="siteId">Site ID</param> <param name="nodeGuid">GUID of the document owner node for reference</param> </member> <member name="M:CMS.PortalEngine.PageTemplateInfoProvider.GetFullPhysicalPath(CMS.PortalEngine.PageTemplateInfo)"> <summary> Gets full path of the page template. </summary> <param name="template">Page template object</param> </member> <member name="M:CMS.PortalEngine.PageTemplateInfoProvider.GetFullPhysicalPath(CMS.PortalEngine.PageTemplateInfo,System.String)"> <summary> Gets full path of the page template. </summary> <param name="template">Page template object</param> <param name="webFullPath">Full path to the root of the web project (e.g. c:\WebProject\)</param> </member> <member name="M:CMS.PortalEngine.PageTemplateInfoProvider.GetPageTemplateTypeEnum(System.String)"> <summary> Gets the page template type enumeration for the given string value. </summary> <param name="type">String type</param> </member> <member name="M:CMS.PortalEngine.PageTemplateInfoProvider.GetPageTemplateTypeCode(CMS.PortalEngine.PageTemplateTypeEnum)"> <summary> Gets the page template type code for the given enum value. </summary> <param name="type">Enumeration type</param> </member> <member name="M:CMS.PortalEngine.PageTemplateInfoProvider.GetVirtualObject(System.String,System.Boolean)"> <summary> Returns web part layout info for specified path </summary> <param name="path">Path</param> <param name="isAdHoc">Indicates whether current object has binding on ad-hoc template</param> </member> <member name="M:CMS.PortalEngine.PageTemplateInfoProvider.GetPageLayoutName(System.String)"> <summary> Gets full layout name from the given virtual layout path. </summary> <param name="url">Virtual layout path</param> <returns>Full layout name</returns> </member> <member name="M:CMS.PortalEngine.PageTemplateInfoProvider.GetAdhocPageLayoutName(System.String)"> <summary> Gets full ad-hoc layout name from the given virtual layout path. </summary> <param name="url">Virtual layout path</param> <returns>Full layout name</returns> </member> <member name="M:CMS.PortalEngine.PageTemplateInfoProvider.GetTemplatesInternal"> <summary> Get all page templates using ObjectQuery. </summary> </member> <member name="M:CMS.PortalEngine.PageTemplateInfoProvider.GetPageTemplateInfoInternal(System.Int32)"> <summary> Gets the page template object for the specified page template ID. </summary> <param name="templateId">Page template ID</param> </member> <member name="M:CMS.PortalEngine.PageTemplateInfoProvider.GetPageTemplateInfoInternal(System.String,System.Int32)"> <summary> Gets the page template object for the specified page template name. </summary> <param name="templateName">Page template name</param> <param name="siteId">Page template site ID</param> </member> <member name="M:CMS.PortalEngine.PageTemplateInfoProvider.SetPageTemplateInfoInternal(CMS.PortalEngine.PageTemplateInfo)"> <summary> Sets (updates or inserts) specified page template. </summary> <param name="template">Page template to set</param> </member> <member name="M:CMS.PortalEngine.PageTemplateInfoProvider.DeleteAdHocTemplatesInternal(System.Guid,System.Int32)"> <summary> Deletes all ad hoc templates for given node (UI element) based on it's GUID. </summary> <param name="guid">Item's GUID</param> <param name="siteId">Site ID</param> </member> <member name="M:CMS.PortalEngine.PageTemplateInfoProvider.EnsureConsistency(CMS.PortalEngine.PageTemplateInfo)"> <summary> Ensures consistency of the page template info data </summary> <param name="template">Page template</param> </member> <member name="M:CMS.PortalEngine.PageTemplateInfoProvider.DeletePageTemplateInfoInternal(CMS.PortalEngine.PageTemplateInfo)"> <summary> Deletes specified page template. </summary> <param name="template">Page template to delete</param> </member> <member name="M:CMS.PortalEngine.PageTemplateInfoProvider.GetAllowedTemplatesInCategoryInternal(System.Int32,System.Int32)"> <summary> Gets page templates allowed for specified site. </summary> <param name="siteId">Site ID</param> <param name="categoryId">Page template category ID</param> </member> <member name="M:CMS.PortalEngine.PageTemplateInfoProvider.GetPageLayoutNameInternal(System.String,System.String)"> <summary> Gets full layout name from the given virtual layout path. </summary> <param name="url">Virtual layout path</param> <param name="directory">Base directory</param> <returns>Full layout name</returns> </member> <member name="P:CMS.PortalEngine.PageTemplateInfoProvider.StorePageTemplatesInExternalStorage"> <summary> Gets or sets the value that indicates whether page template/device layouts should be stored externally </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateInfoProvider.CreateSearchTasks"> <summary> Gets or sets the value that indicates whether search tasks should be created if template was changed. </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateInfoProvider.ClonePageTemplateInfo"> <summary> If true, page info which is retrieved by the methods is a clone of the original page info object. </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateInfoProvider.TemplateLayoutsDirectory"> <summary> Gets the template layouts directory. </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateInfoProvider.AdhocTemplateLayoutsDirectory"> <summary> Gets the ad-hoc template layouts directory. </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateInfoProvider.TemplatesDirectory"> <summary> Gets the template layouts directory. </summary> </member> <member name="T:CMS.PortalEngine.PageTemplateSiteInfo"> <summary> PageTemplateSiteInfo data container class. </summary> </member> <member name="F:CMS.PortalEngine.PageTemplateSiteInfo.OBJECT_TYPE"> <summary> Object type </summary> </member> <member name="F:CMS.PortalEngine.PageTemplateSiteInfo.TYPEINFO"> <summary> Type information. </summary> </member> <member name="M:CMS.PortalEngine.PageTemplateSiteInfo.DeleteObject"> <summary> Deletes the object using appropriate provider. </summary> </member> <member name="M:CMS.PortalEngine.PageTemplateSiteInfo.SetObject"> <summary> Updates the object using appropriate provider. </summary> </member> <member name="M:CMS.PortalEngine.PageTemplateSiteInfo.#ctor"> <summary> Constructor - Creates an empty PageTemplateSiteInfo object. </summary> </member> <member name="M:CMS.PortalEngine.PageTemplateSiteInfo.#ctor(System.Data.DataRow)"> <summary> Constructor - Creates a new PageTemplateSiteInfo object from the given DataRow. </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateSiteInfo.SiteID"> <summary> Site ID. </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateSiteInfo.PageTemplateID"> <summary> Page template ID. </summary> </member> <member name="T:CMS.PortalEngine.PageTemplateSiteInfoProvider"> <summary> Class providing PageTemplateSiteInfo management. </summary> </member> <member name="M:CMS.PortalEngine.PageTemplateSiteInfoProvider.GetPageTemplateSiteInfo(System.Int32,System.Int32)"> <summary> Returns the PageTemplateSiteInfo structure for the specified pageTemplateSite. </summary> <param name="pageTemplateId">PageTemplateID</param> <param name="siteId">SiteID</param> </member> <member name="M:CMS.PortalEngine.PageTemplateSiteInfoProvider.GetPageTemplateSites"> <summary> Return all page template -- site binding. </summary> </member> <member name="M:CMS.PortalEngine.PageTemplateSiteInfoProvider.SetPageTemplateSiteInfo(CMS.PortalEngine.PageTemplateSiteInfo)"> <summary> Sets (updates or inserts) specified pageTemplateSite. </summary> <param name="pageTemplateSite">PageTemplateSite to set</param> </member> <member name="M:CMS.PortalEngine.PageTemplateSiteInfoProvider.DeletePageTemplateSiteInfo(CMS.PortalEngine.PageTemplateSiteInfo)"> <summary> Deletes specified pageTemplateSite. </summary> <param name="infoObj">PageTemplateSite object</param> </member> <member name="M:CMS.PortalEngine.PageTemplateSiteInfoProvider.RemovePageTemplateFromSite(System.Int32,System.Int32)"> <summary> Deletes specified pageTemplateSite. </summary> <param name="pageTemplateId">PageTemplateID</param> <param name="siteId">SiteID</param> </member> <member name="M:CMS.PortalEngine.PageTemplateSiteInfoProvider.AddPageTemplateToSite(System.Int32,System.Int32)"> <summary> Adds the class to the specified site. </summary> <param name="pageTemplateId">PageTemplateID</param> <param name="siteId">SiteID</param> </member> <member name="M:CMS.PortalEngine.PageTemplateSiteInfoProvider.IsPageTemplateOnSite(System.Int32,System.Int32)"> <summary> Check if exists relation between page template with pagetemplateId and site with siteId. </summary> <param name="pageTemplateId">Page template ID</param> <param name="siteId">Site ID</param> </member> <member name="M:CMS.PortalEngine.PageTemplateSiteInfoProvider.GetPageTemplateSitesInternal"> <summary> Return all page template -- site binding. </summary> </member> <member name="M:CMS.PortalEngine.PageTemplateSiteInfoProvider.GetPageTemplateSiteInfoInternal(System.Int32,System.Int32)"> <summary> Returns the PageTemplateSiteInfo structure for the specified pageTemplateSite. </summary> <param name="pageTemplateId">PageTemplateID</param> <param name="siteId">SiteID</param> </member> <member name="M:CMS.PortalEngine.PageTemplateSiteInfoProvider.SetPageTemplateSiteInfoInternal(CMS.PortalEngine.PageTemplateSiteInfo)"> <summary> Sets (updates or inserts) specified pageTemplateSite. </summary> <param name="pageTemplateSite">PageTemplateSite to set</param> </member> <member name="M:CMS.PortalEngine.PageTemplateSiteInfoProvider.DeletePageTemplateSiteInfoInternal(CMS.PortalEngine.PageTemplateSiteInfo)"> <summary> Deletes specified pageTemplateSite. </summary> <param name="infoObj">PageTemplateSite object</param> </member> <member name="M:CMS.PortalEngine.PageTemplateSiteInfoProvider.RemovePageTemplateFromSiteInternal(System.Int32,System.Int32)"> <summary> Deletes specified pageTemplateSite. </summary> <param name="pageTemplateId">PageTemplateID</param> <param name="siteId">SiteID</param> </member> <member name="M:CMS.PortalEngine.PageTemplateSiteInfoProvider.AddPageTemplateToSiteInternal(System.Int32,System.Int32)"> <summary> Adds the class to the specified site. </summary> <param name="pageTemplateId">PageTemplateID</param> <param name="siteId">SiteID</param> </member> <member name="T:CMS.PortalEngine.PageTemplateTreeNode"> <summary> Tree node representation for the page template. </summary> </member> <member name="M:CMS.PortalEngine.PageTemplateTreeNode.#ctor(System.Web.SiteMapProvider,System.String)"> <summary> Constructor. </summary> <param name="provider">TreeSiteMapProvider</param> <param name="key">Node key</param> </member> <member name="M:CMS.PortalEngine.PageTemplateTreeNode.#ctor(System.Web.SiteMapProvider,System.String,System.String)"> <summary> Constructor. </summary> <param name="provider">TreeSiteMapProvider</param> <param name="key">Node key</param> <param name="url">Node URL</param> </member> <member name="M:CMS.PortalEngine.PageTemplateTreeNode.#ctor(System.Web.SiteMapProvider,System.String,System.String,System.String)"> <summary> Constructor. </summary> <param name="provider">TreeSiteMapProvider</param> <param name="key">Node key</param> <param name="url">Node URL</param> <param name="title">Node title</param> </member> <member name="M:CMS.PortalEngine.PageTemplateTreeNode.#ctor(System.Web.SiteMapProvider,System.String,System.String,System.String,System.String)"> <summary> Constructor. </summary> <param name="provider">TreeSiteMapProvider</param> <param name="key">Node key</param> <param name="url">Node URL</param> <param name="title">Node title</param> <param name="description">Node description</param> </member> <member name="P:CMS.PortalEngine.PageTemplateTreeNode.ItemData"> <summary> Property to get and set the inner object. </summary> </member> <member name="T:CMS.PortalEngine.PageTemplateTreeProvider"> <summary> Page template tree structure provider. </summary> </member> <member name="F:CMS.PortalEngine.PageTemplateTreeProvider.mPageTemplates"> <summary> A table of all the page templates, indexed by PageTemplateID. </summary> </member> <member name="F:CMS.PortalEngine.PageTemplateTreeProvider.mCategories"> <summary> A table of all the categories, indexed by CategoryID. </summary> </member> <member name="F:CMS.PortalEngine.PageTemplateTreeProvider.mRootNode"> <summary> Sitemap root node. </summary> </member> <member name="F:CMS.PortalEngine.PageTemplateTreeProvider.mSiteId"> <summary> If is set to value greater than zero then only allowed templates will be shown in page template tree. </summary> </member> <member name="M:CMS.PortalEngine.PageTemplateTreeProvider.GetRootNodeCore"> <summary> Returns the the root sitemap node. </summary> </member> <member name="M:CMS.PortalEngine.PageTemplateTreeProvider.Clear"> <summary> Clean up any collections or other state that an instance of this may hold. </summary> </member> <member name="M:CMS.PortalEngine.PageTemplateTreeProvider.ReloadData"> <summary> Reloads the tree data. </summary> </member> <member name="M:CMS.PortalEngine.PageTemplateTreeProvider.BuildSiteMap"> <summary> Performs the tree build. </summary> </member> <member name="M:CMS.PortalEngine.PageTemplateTreeProvider.RemoveEmptyCategories(System.Data.DataSet)"> <summary> Removes categories with no page templates. </summary> <param name="ds">Dataset with the categories data</param> </member> <member name="M:CMS.PortalEngine.PageTemplateTreeProvider.PopulateCategories(System.Data.DataSet,System.Web.SiteMapNode)"> <summary> Populates the categories within the tree (up-down processing). </summary> <param name="ds">Dataset with the categories data</param> <param name="parentNode">Parent category node</param> </member> <member name="M:CMS.PortalEngine.PageTemplateTreeProvider.GetPageTemplateById(System.Int32)"> <summary> Returns the PageTemplate specified by given PageTemplate ID. </summary> <param name="pageTemplateId">PageTemplate ID to retrieve</param> </member> <member name="M:CMS.PortalEngine.PageTemplateTreeProvider.GetPageTemplateCategoryById(System.Int32)"> <summary> Returns the PageTemplateCategory specified by given PageTemplateCategory ID. </summary> <param name="pageTemplateCategoryId">PageTemplateCategory ID to retrieve</param> </member> <member name="P:CMS.PortalEngine.PageTemplateTreeProvider.ShowOnlyAllowedForSiteId"> <summary> If is set to value greater than zero then only allowed templates will be shown in page template tree. </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateTreeProvider.ShowOnlyCategories"> <summary> True if only categories should be shown. </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateTreeProvider.RootNode"> <summary> Property to get root node for the tree. </summary> </member> <member name="P:CMS.PortalEngine.PageTemplateTreeProvider.BindItemData"> <summary> Specifies if the item data should be bound to the nodes. </summary> </member> <member name="T:CMS.PortalEngine.WebPartLayoutException"> <summary> Web part layout exception. </summary> </member> <member name="M:CMS.PortalEngine.WebPartLayoutException.#ctor(System.String)"> <summary> Constructor. </summary> <param name="message">Message</param> </member> <member name="T:CMS.PortalEngine.WebPartLayoutVirtualFileObject"> <summary> Layout virtual file object </summary> </member> <member name="M:CMS.PortalEngine.WebPartLayoutVirtualFileObject.#ctor(CMS.PortalEngine.WebPartLayoutInfo)"> <summary> Constructor </summary> <param name="currentObject">Object instance</param> </member> <member name="M:CMS.PortalEngine.WebPartLayoutVirtualFileObject.GetVirtualFileObject(System.String)"> <summary> Creates IVirtualFileObject for specified virtual path (GetVirtualFileObjectHandler callback method) </summary> <param name="virtualPath">Virtual path</param> </member> <member name="P:CMS.PortalEngine.WebPartLayoutVirtualFileObject.Content"> <summary> Gets virtual file content for current object </summary> </member> <member name="P:CMS.PortalEngine.WebPartLayoutVirtualFileObject.IsStoredExternally"> <summary> Indicates whether file content is stored externally (e.g. file system) </summary> </member> <member name="P:CMS.PortalEngine.WebPartLayoutVirtualFileObject.ObjectHash"> <summary> Gets object hash string used for identification of compiled version in .NET cache </summary> </member> <member name="P:CMS.PortalEngine.WebPartLayoutVirtualFileObject.PhysicalFilePath"> <summary> Gets the physical file path if exists </summary> </member> <member name="P:CMS.PortalEngine.WebPartLayoutVirtualFileObject.CurrentObject"> <summary> Current object instance </summary> </member> <member name="T:CMS.PortalEngine.VariantHelper"> <summary> Helper class for portal engine variants </summary> </member> <member name="M:CMS.PortalEngine.VariantHelper.GetVariants(CMS.PortalEngine.VariantModeEnum,System.Int32,System.String,System.Guid,System.Int32)"> <summary> Returns variants for given type and documents or template </summary> <param name="type">Variant type</param> <param name="templateID">Template info ID</param> <param name="zoneID">Zone instance ID</param> <param name="instanceGuid">Instance's Guid</param> <param name="documentID">Document ID </param> </member> <member name="M:CMS.PortalEngine.VariantHelper.SetVariantWebParts(CMS.PortalEngine.VariantModeEnum,System.Int32,System.Xml.XmlNode)"> <summary> Saves the variants </summary> <param name="type">Variant type</param> <param name="variantID">Varaint's (zone or webpart) ID</param> <param name="xmlWebParts">XML (webpart or zone) definition</param> </member> <member name="M:CMS.PortalEngine.VariantHelper.SetVariantWebParts(CMS.PortalEngine.WebPartZoneInstance,System.Int32)"> <summary> Saves the variant. </summary> <param name="zone">The zone instance</param> <param name="variantId">The variant id</param> </member> <member name="M:CMS.PortalEngine.VariantHelper.SetVariant(CMS.PortalEngine.VariantModeEnum,CMS.PortalEngine.VariantSettings,System.Xml.XmlNode)"> <summary> Saves variant's properties </summary> <param name="type">Variant type</param> <param name="variant">Settings object with variant information</param> <param name="xmlDefinition">XML node (webpart or zone) definition</param> </member> <member name="M:CMS.PortalEngine.VariantHelper.SaveWebPartVariantChanges(CMS.PortalEngine.WebPartInstance,System.Int32,System.Int32,CMS.PortalEngine.VariantModeEnum,System.Collections.Hashtable)"> <summary> Saves the web part variant changes (MVT/Content personalization variants). </summary> <param name="webPartInstance">The web part instance</param> <param name="variantId">The variant id</param> <param name="zoneVariantId">The zone variant id</param> <param name="variantMode">The variant mode</param> <param name="variantProperties">The variant properties</param> </member> <member name="M:CMS.PortalEngine.VariantHelper.DeleteWidgetVariants(System.String,System.Int32,System.Int32)"> <summary> Removes all widget variants and their combinations. </summary> <param name="zoneID">The zone id</param> <param name="pageTemplateID">The page template id</param> <param name="documentID">The document id</param> </member> <member name="M:CMS.PortalEngine.VariantHelper.GetVariantID(CMS.PortalEngine.VariantModeEnum,System.Int32,System.String,System.Nullable{System.Boolean})"> <summary> Return variant ID based on name and page template ID </summary> <param name="type">Type of variant</param> <param name="pageTemplateID">Variant's page template ID</param> <param name="variantName">Variant's name</param> <param name="documentIdIsNull">If set, adds check to SQL query whether the variant document id is null or not</param> </member> <member name="T:CMS.PortalEngine.VirtualWebPartVirtualFileObject"> <summary> Virtual web part virtual file object </summary> </member> <member name="M:CMS.PortalEngine.VirtualWebPartVirtualFileObject.#ctor(System.String)"> <summary> Constructor </summary> <param name="virtualPath">Virtual path</param> </member> <member name="M:CMS.PortalEngine.VirtualWebPartVirtualFileObject.GetVirtualFileObject(System.String)"> <summary> Creates IVirtualFileObject for specified virtual path (GetVirtualFileObjectHandler callback method) </summary> <param name="virtualPath">Virtual path</param> </member> <member name="M:CMS.PortalEngine.VirtualWebPartVirtualFileObject.Parse(System.String)"> <summary> Parse virtual path from format WebPartInfoProvider.VirtualWebPartsDirectory + /DocumentID/NodeID/ControlID---pc/WebPartID/WebPartLayoutID.ascx </summary> <param name="virtualPath">Virtual path</param> </member> <member name="P:CMS.PortalEngine.VirtualWebPartVirtualFileObject.Content"> <summary> Gets virtual file content for current object </summary> </member> <member name="P:CMS.PortalEngine.VirtualWebPartVirtualFileObject.IsStoredExternally"> <summary> Indicates whether file content is stored externally (e.g. file system) </summary> </member> <member name="P:CMS.PortalEngine.VirtualWebPartVirtualFileObject.ObjectHash"> <summary> Gets object hash string used for identification of compiled version in .NET cache </summary> </member> <member name="P:CMS.PortalEngine.VirtualWebPartVirtualFileObject.PhysicalFilePath"> <summary> Gets the physical file path if exists </summary> </member> <member name="P:CMS.PortalEngine.VirtualWebPartVirtualFileObject.WebPartLayoutID"> <summary> Web part layout id </summary> </member> <member name="P:CMS.PortalEngine.VirtualWebPartVirtualFileObject.WebPartID"> <summary> Web part id </summary> </member> <member name="P:CMS.PortalEngine.VirtualWebPartVirtualFileObject.UsePartialCache"> <summary> Indicates whether web part partial cache should be used </summary> </member> <member name="F:CMS.PortalEngine.WebPartListInfo.OBJECT_TYPE"> <summary> Object type </summary> </member> <member name="F:CMS.PortalEngine.WebPartListInfo.TYPEINFO"> <summary> Type information. </summary> </member> <member name="M:CMS.PortalEngine.WebPartListInfo.#ctor"> <summary> Constructor - Creates an empty WebPartCategoryListInfo object. </summary> </member> <member name="M:CMS.PortalEngine.WebPartListInfo.#ctor(System.Data.DataRow)"> <summary> Constructor - Creates a new WebPartCategoryListInfo object from the given DataRow. </summary> <param name="dr">DataRow with the object data</param> </member> <member name="M:CMS.PortalEngine.WebPartListInfo.GetColumnNames"> <summary> Gets the default list of column names for this class </summary> </member> <member name="M:CMS.PortalEngine.WebPartListInfo.GetDataQueryInternal"> <summary> Gets the data query for this object type </summary> </member> <member name="T:CMS.PortalEngine.PartialCacheHelper"> <summary> Provides helper methods for web part partial cache functionality. </summary> </member> <member name="F:CMS.PortalEngine.PartialCacheHelper.VARY_BY_NOT_CONFIGURED"> <summary> Value indicating that VaryByParam/VaryByCustom are not configured yet. </summary> </member> <member name="M:CMS.PortalEngine.PartialCacheHelper.AddOutputCacheDirective(System.String)"> <summary> Adds the OutputCache directive into the given ASCX markup when not present yet. </summary> </member> <member name="T:CMS.PortalEngine.WebPartVirtualPageTemplateInfo"> <summary> Web part virtual page template info </summary> </member> <member name="M:CMS.PortalEngine.WebPartVirtualPageTemplateInfo.#ctor(CMS.PortalEngine.WebPartInfo)"> <summary> Constructor </summary> <param name="webPartInfo">Web part info</param> </member> <member name="M:CMS.PortalEngine.WebPartVirtualPageTemplateInfo.InsertData"> <summary> Inserts the data </summary> </member> <member name="M:CMS.PortalEngine.WebPartVirtualPageTemplateInfo.DeleteData"> <summary> Deletes the data </summary> </member> <member name="M:CMS.PortalEngine.WebPartVirtualPageTemplateInfo.UpdateData"> <summary> Updates the data </summary> </member> <member name="M:CMS.PortalEngine.WebPartVirtualPageTemplateInfo.IsCheckedOutByUser(CMS.Base.IUserInfo)"> <summary> Indicates if the object is checked out by given user. </summary> </member> <member name="P:CMS.PortalEngine.WebPartVirtualPageTemplateInfo.WebPartInfo"> <summary> Parent web part info </summary> </member> <member name="F:CMS.PortalEngine.WidgetListInfo.OBJECT_TYPE"> <summary> Object type </summary> </member> <member name="F:CMS.PortalEngine.WidgetListInfo.TYPEINFO"> <summary> Type information. </summary> </member> <member name="M:CMS.PortalEngine.WidgetListInfo.#ctor"> <summary> Constructor - Creates an empty WidgetCategoryListInfo object. </summary> </member> <member name="M:CMS.PortalEngine.WidgetListInfo.#ctor(System.Data.DataRow)"> <summary> Constructor - Creates a new WidgetCategoryListInfo object from the given DataRow. </summary> <param name="dr">DataRow with the object data</param> </member> <member name="M:CMS.PortalEngine.WidgetListInfo.GetColumnNames"> <summary> Gets the default list of column names for this class </summary> </member> <member name="M:CMS.PortalEngine.WidgetListInfo.GetDataQueryInternal"> <summary> Gets the data query for this object type </summary> </member> <member name="T:CMS.PortalEngine.WidgetRoleInfoProvider"> <summary> Class providing WidgetRoleInfo management. </summary> </member> <member name="M:CMS.PortalEngine.WidgetRoleInfoProvider.GetWidgetRoleInfos"> <summary> Returns all widget -- role bindings. </summary> </member> <member name="M:CMS.PortalEngine.WidgetRoleInfoProvider.GetWidgetRoleInfo(System.Int32,System.Int32,System.Int32)"> <summary> Returns the WidgetRoleInfo structure for the specified widget and role. </summary> <param name="widgetId">Widget id</param> <param name="roleId">Role id</param> <param name="permissionId">Permission id</param> </member> <member name="M:CMS.PortalEngine.WidgetRoleInfoProvider.GetWidgetRoles(System.String,System.String,System.Int32,System.String)"> <summary> Returns all widget-role bindings according to parameters. </summary> <param name="columns">Column names</param> <param name="where">Where condition to filter data</param> <param name="orderBy">Order by statement</param> <param name="topN">Number of items that should be returned (all if 0)</param> </member> <member name="M:CMS.PortalEngine.WidgetRoleInfoProvider.SetWidgetRoleInfo(CMS.PortalEngine.WidgetRoleInfo)"> <summary> Sets (updates or inserts) specified widget role info. </summary> <param name="wri">WidgetRole to set</param> </member> <member name="M:CMS.PortalEngine.WidgetRoleInfoProvider.DeleteWidgetRoleInfo(CMS.PortalEngine.WidgetRoleInfo)"> <summary> Deletes specified widget-role. </summary> <param name="wri">WidgetRole object</param> </member> <member name="M:CMS.PortalEngine.WidgetRoleInfoProvider.AddRoleToWidget(System.Int32,System.Int32,System.Int32)"> <summary> Adds specified role and permission to the widget. </summary> <param name="roleId">Role ID</param> <param name="widgetId">Widget ID</param> <param name="permissionId">Permission ID</param> </member> <member name="M:CMS.PortalEngine.WidgetRoleInfoProvider.RemoveRoleFromWidget(System.Int32,System.Int32,System.Int32)"> <summary> Deletes specified widgetRole. </summary> <param name="roleId">RoleID</param> <param name="widgetId">WidgetID</param> <param name="permissionId">Permission ID</param> </member> <member name="M:CMS.PortalEngine.WidgetRoleInfoProvider.IsWidgetAllowed(System.Int32,System.Int32,System.Boolean)"> <summary> Returns true if widget is allowed for specified user. </summary> <param name="widgetId">ID of the widget</param> <param name="userId">ID of the accessing user</param> <param name="isAuthenticated">Value indicating if accessing user is authenticated</param> </member> <member name="M:CMS.PortalEngine.WidgetRoleInfoProvider.IsWidgetAllowed(CMS.PortalEngine.WidgetInfo,System.Int32,System.Boolean)"> <summary> Return true if widget is allowed for specified user. Only security settings is considered. Widget still can be allowed for group admins. </summary> <param name="wi">Widget info</param> <param name="userId">ID of the accessing user</param> <param name="isAuthenticated">Value indicating if accessing user is authenticated</param> </member> <member name="M:CMS.PortalEngine.WidgetRoleInfoProvider.GetWidgetRoleInfosInternal"> <summary> Returns all widget -- role bindings. </summary> </member> <member name="M:CMS.PortalEngine.WidgetRoleInfoProvider.GetWidgetRoleInfoInternal(System.Int32,System.Int32,System.Int32)"> <summary> Returns the WidgetRoleInfo structure for the specified widget and role. </summary> <param name="widgetId">Widget id</param> <param name="roleId">Role id</param> <param name="permissionId">Permission id</param> </member> <member name="M:CMS.PortalEngine.WidgetRoleInfoProvider.GetWidgetRolesInternal(System.String,System.String,System.String,System.Int32)"> <summary> Returns all widget-role bindings according to parameters. </summary> <param name="columns">Column names</param> <param name="where">Where condition to filter data</param> <param name="orderBy">Order by statement</param> <param name="topN">Number of items that should be returned (all if 0)</param> </member> <member name="M:CMS.PortalEngine.WidgetRoleInfoProvider.SetWidgetRoleInfoInternal(CMS.PortalEngine.WidgetRoleInfo)"> <summary> Sets (updates or inserts) specified widget-role. </summary> <param name="wri">Widget to set</param> </member> <member name="M:CMS.PortalEngine.WidgetRoleInfoProvider.DeleteWidgetRoleInfoInternal(CMS.PortalEngine.WidgetRoleInfo)"> <summary> Deletes specified widget-role. </summary> <param name="infoObj">WidgetRole object</param> </member> <member name="T:CMS.PortalEngine.WidgetRoleInfo"> <summary> WidgetRole info class. </summary> </member> <member name="F:CMS.PortalEngine.WidgetRoleInfo.OBJECT_TYPE"> <summary> Object type </summary> </member> <member name="F:CMS.PortalEngine.WidgetRoleInfo.TYPEINFO"> <summary> Type information. </summary> </member> <member name="M:CMS.PortalEngine.WidgetRoleInfo.DeleteObject"> <summary> Deletes the object using appropriate provider. </summary> </member> <member name="M:CMS.PortalEngine.WidgetRoleInfo.SetObject"> <summary> Updates the object using appropriate provider. </summary> </member> <member name="M:CMS.PortalEngine.WidgetRoleInfo.#ctor"> <summary> Constructor - Creates an empty WidgetRoleInfo object. </summary> </member> <member name="M:CMS.PortalEngine.WidgetRoleInfo.#ctor(System.Data.DataRow)"> <summary> Constructor - Creates a new WidgetRoleInfo object from the given DataRow. </summary> </member> <member name="M:CMS.PortalEngine.WidgetRoleInfo.#ctor(CMS.PortalEngine.WidgetRoleInfo,System.Boolean)"> <summary> Constructor - Creates a new WidgetRoleInfo object from the given DataClass. </summary> <param name="wri">WidgetRoleInfo</param> <param name="keepSourceData">If true, source data are kept in the object</param> </member> <member name="P:CMS.PortalEngine.WidgetRoleInfo.WidgetID"> <summary> Gets or set the widget ID. </summary> </member> <member name="P:CMS.PortalEngine.WidgetRoleInfo.RoleID"> <summary> Gets or set the role ID. </summary> </member> <member name="P:CMS.PortalEngine.WidgetRoleInfo.PermissionID"> <summary> Permission ID. </summary> </member> <member name="T:CMS.PortalEngine.WidgetCategoryInfoProvider"> <summary> Class providing WidgetCategoryInfo management. </summary> </member> <member name="M:CMS.PortalEngine.WidgetCategoryInfoProvider.GetWidgetCategoryInfo(System.Int32)"> <summary> Returns the WidgetCategoryInfo structure for the specified widget category. </summary> <param name="widgetCategoryId">Widget category id</param> </member> <member name="M:CMS.PortalEngine.WidgetCategoryInfoProvider.GetWidgetCategoryInfo(System.Guid)"> <summary> Returns the WidgetCategoryInfo structure for the specified widget category GUID. </summary> <param name="widgetGuid">Widget category Guid</param> <returns>Widget category info object</returns> </member> <member name="M:CMS.PortalEngine.WidgetCategoryInfoProvider.GetWidgetCategoryInfo(System.String)"> <summary> Returns the WidgetCategoryInfo structure for the specified widget category name. </summary> <param name="categoryName">Widget category name</param> </member> <member name="M:CMS.PortalEngine.WidgetCategoryInfoProvider.GetWidgetCategories"> <summary> Returns all widget categories. </summary> </member> <member name="M:CMS.PortalEngine.WidgetCategoryInfoProvider.GetWidgetCategories(System.Int32)"> <summary> Gets dataset with child categories of specified category. </summary> <param name="parentCategoryId">ID of category to retrieve sub-categories</param> </member> <member name="M:CMS.PortalEngine.WidgetCategoryInfoProvider.SetWidgetCategoryInfo(CMS.PortalEngine.WidgetCategoryInfo)"> <summary> Sets (updates or inserts) specified widget category. </summary> <param name="widgetCategory">Widget category to set</param> </member> <member name="M:CMS.PortalEngine.WidgetCategoryInfoProvider.DeleteWidgetCategoryInfo(CMS.PortalEngine.WidgetCategoryInfo)"> <summary> Deletes specified widget category with dependencies. </summary> <param name="infoObj">Widget category object</param> </member> <member name="M:CMS.PortalEngine.WidgetCategoryInfoProvider.DeleteWidgetCategoryInfo(System.Int32)"> <summary> Deletes specified widget category with dependencies. </summary> <param name="widgetCategoryId">Widget category ID</param> </member> <member name="M:CMS.PortalEngine.WidgetCategoryInfoProvider.UpdateCategoryChildCount(System.Int32,System.Int32)"> <summary> Updates the child categories count of widget category. </summary> <param name="originalParentID">Original parent ID</param> <param name="newParentID">New parent ID</param> </member> <member name="M:CMS.PortalEngine.WidgetCategoryInfoProvider.UpdateCategoryWidgetChildCount(System.Int32,System.Int32)"> <summary> Updates the child widget count of widget category. </summary> <param name="originalParentID">Original parent ID</param> <param name="newParentID">New parent ID</param> </member> <member name="M:CMS.PortalEngine.WidgetCategoryInfoProvider.RefreshDataCounts"> <summary> Updates all counts for all sub-objects. </summary> </member> <member name="M:CMS.PortalEngine.WidgetCategoryInfoProvider.RefreshObjectsCounts"> <summary> Updates all counts for all sub-objects. </summary> </member> <member name="M:CMS.PortalEngine.WidgetCategoryInfoProvider.GetWidgetCategoriesInternal"> <summary> Returns all widget categories. </summary> </member> <member name="M:CMS.PortalEngine.WidgetCategoryInfoProvider.GetWidgetCategoriesInternal(System.String,System.String,System.String,System.Int32)"> <summary> Returns all widget categories according to parameters. </summary> <param name="columns">Returned columns</param> <param name="where">Where condition to filter data</param> <param name="orderBy">Order by statement</param> <param name="topN">Top N rows</param> </member> <member name="M:CMS.PortalEngine.WidgetCategoryInfoProvider.GetWidgetCategoryInfoInternal(System.Int32)"> <summary> Returns the WidgetCategoryInfo structure for the specified widget category. </summary> <param name="widgetCategoryId">Widget category id</param> </member> <member name="M:CMS.PortalEngine.WidgetCategoryInfoProvider.GetWidgetCategoryInfoByGuidInternal(System.Guid)"> <summary> Returns the WidgetCategoryInfo structure for the specified guid. </summary> <param name="guid">Widget category Guid</param> </member> <member name="M:CMS.PortalEngine.WidgetCategoryInfoProvider.GetWidgetCategoryInfoInternal(System.String)"> <summary> Returns the WidgetCategoryInfo structure for the specified widget category name. </summary> <param name="categoryName">Widget category name</param> </member> <member name="M:CMS.PortalEngine.WidgetCategoryInfoProvider.SetWidgetCategoryInfoInternal(CMS.PortalEngine.WidgetCategoryInfo)"> <summary> Sets (updates or inserts) specified widget category. </summary> <param name="widgetCategory">Widget category to set</param> </member> <member name="M:CMS.PortalEngine.WidgetCategoryInfoProvider.UpdateCategoryChildCountInternal(System.Int32,System.Int32)"> <summary> Updates the child categories count of widget category. </summary> <param name="originalParentID">Original parent ID</param> <param name="newParentID">New parent ID</param> </member> <member name="M:CMS.PortalEngine.WidgetCategoryInfoProvider.UpdateCategoryWidgetChildCountInternal(System.Int32,System.Int32)"> <summary> Updates the child widget count of widget category. </summary> <param name="originalParentID">Original parent ID</param> <param name="newParentID">New parent ID</param> </member> <member name="M:CMS.PortalEngine.WidgetCategoryInfoProvider.RefreshDataCountsInternal"> <summary> Updates all counts for all sub-objects. </summary> </member> <member name="M:CMS.PortalEngine.WidgetCategoryInfoProvider.DeleteWidgetCategoryInfoInternal(CMS.PortalEngine.WidgetCategoryInfo)"> <summary> Deletes specified widget category with dependencies. </summary> <param name="infoObj">Widget category object</param> </member> <member name="T:CMS.PortalEngine.WidgetCategoryInfo"> <summary> Widget category info class. </summary> </member> <member name="F:CMS.PortalEngine.WidgetCategoryInfo.OBJECT_TYPE"> <summary> Object type </summary> </member> <member name="F:CMS.PortalEngine.WidgetCategoryInfo.TYPEINFO"> <summary> Type information. </summary> </member> <member name="M:CMS.PortalEngine.WidgetCategoryInfo.DeleteObject"> <summary> Deletes the object using appropriate provider. </summary> </member> <member name="M:CMS.PortalEngine.WidgetCategoryInfo.SetObject"> <summary> Updates the object using appropriate provider. </summary> </member> <member name="M:CMS.PortalEngine.WidgetCategoryInfo.#ctor"> <summary> Constructor - Creates an empty WidgetCategoryInfo object. </summary> </member> <member name="M:CMS.PortalEngine.WidgetCategoryInfo.#ctor(System.Data.DataRow)"> <summary> Constructor - Creates a new WidgetCategoryInfo object from the given DataRow. </summary> </member> <member name="M:CMS.PortalEngine.WidgetCategoryInfo.#ctor(CMS.PortalEngine.WidgetCategoryInfo,System.Boolean)"> <summary> Constructor - Creates a new WidgetCategoryInfo object from the given DataClass. </summary> <param name="wci">WidgetCategoryInfo</param> <param name="keepSourceData">If true, source data are kept in the object</param> </member> <member name="P:CMS.PortalEngine.WidgetCategoryInfo.WidgetCategoryID"> <summary> Widget category ID. </summary> </member> <member name="P:CMS.PortalEngine.WidgetCategoryInfo.WidgetCategoryName"> <summary> Widget category name. </summary> </member> <member name="P:CMS.PortalEngine.WidgetCategoryInfo.WidgetCategoryDisplayName"> <summary> Display name. </summary> </member> <member name="P:CMS.PortalEngine.WidgetCategoryInfo.WidgetCategoryGUID"> <summary> Widget category GUID. </summary> </member> <member name="P:CMS.PortalEngine.WidgetCategoryInfo.WidgetCategoryLastModified"> <summary> Time of last modification. </summary> </member> <member name="P:CMS.PortalEngine.WidgetCategoryInfo.WidgetCategoryParentID"> <summary> Gets or sets the ID of parent widget category. </summary> </member> <member name="P:CMS.PortalEngine.WidgetCategoryInfo.WidgetCategoryLevel"> <summary> Gets or set the level of widget category. </summary> </member> <member name="P:CMS.PortalEngine.WidgetCategoryInfo.WidgetCategoryChildCount"> <summary> Gets or sets the child count of widget category. </summary> </member> <member name="P:CMS.PortalEngine.WidgetCategoryInfo.WidgetCategoryWidgetChildCount"> <summary> Gets or sets the child count of widgets under widget category. </summary> </member> <member name="P:CMS.PortalEngine.WidgetCategoryInfo.WidgetCategoryPath"> <summary> Gets or sets the widget category path. </summary> </member> <member name="P:CMS.PortalEngine.WidgetCategoryInfo.WidgetCategoryImagePath"> <summary> Gets or sets the widget category image path. </summary> </member> <member name="P:CMS.PortalEngine.WidgetCategoryInfo.ValidateCodeName"> <summary> If true, the code name is validated upon saving. </summary> </member> <member name="T:CMS.PortalEngine.WebPartTypeEnum"> <summary> Web part type enumeration. </summary> </member> <member name="F:CMS.PortalEngine.WebPartTypeEnum.Standard"> <summary> Standard webpart. </summary> </member> <member name="F:CMS.PortalEngine.WebPartTypeEnum.DataSource"> <summary> DataSource webpart. </summary> </member> <member name="F:CMS.PortalEngine.WebPartTypeEnum.Filter"> <summary> Filter webpart. </summary> </member> <member name="F:CMS.PortalEngine.WebPartTypeEnum.Placeholder"> <summary> Placeholder webpart. </summary> </member> <member name="F:CMS.PortalEngine.WebPartTypeEnum.Invisible"> <summary> Invisible webpart. </summary> </member> <member name="F:CMS.PortalEngine.WebPartTypeEnum.Basic"> <summary> Basic webpart. </summary> </member> <member name="F:CMS.PortalEngine.WebPartTypeEnum.Layout"> <summary> Layout webpart. </summary> </member> <member name="F:CMS.PortalEngine.WebPartTypeEnum.WidgetOnly"> <summary> Widget only. </summary> </member> <member name="F:CMS.PortalEngine.WebPartTypeEnum.UI"> <summary> User interface </summary> </member> <member name="F:CMS.PortalEngine.WebPartTypeEnum.BasicViewer"> <summary> Basic viewer webpart. </summary> </member> <member name="T:CMS.PortalEngine.WebPartCategoryInfo"> <summary> WebPartCategory info data container class. </summary> </member> <member name="F:CMS.PortalEngine.WebPartCategoryInfo.OBJECT_TYPE"> <summary> Object type </summary> </member> <member name="F:CMS.PortalEngine.WebPartCategoryInfo.TYPEINFO"> <summary> Type information. </summary> </member> <member name="M:CMS.PortalEngine.WebPartCategoryInfo.DeleteObject"> <summary> Deletes the object using appropriate provider. </summary> </member> <member name="M:CMS.PortalEngine.WebPartCategoryInfo.SetObject"> <summary> Updates the object using appropriate provider. </summary> </member> <member name="M:CMS.PortalEngine.WebPartCategoryInfo.#ctor"> <summary> Constructor, creates an empty WebPartCategoryInfo structure. </summary> </member> <member name="M:CMS.PortalEngine.WebPartCategoryInfo.#ctor(System.Data.DataRow)"> <summary> Constructor, creates an empty LayoutInfo object from the given DataRow data. </summary> <param name="dr">Datarow with the class info data</param> </member> <member name="P:CMS.PortalEngine.WebPartCategoryInfo.CategoryID"> <summary> The category ID. </summary> </member> <member name="P:CMS.PortalEngine.WebPartCategoryInfo.CategoryDisplayName"> <summary> The Category Display Name. </summary> </member> <member name="P:CMS.PortalEngine.WebPartCategoryInfo.CategoryParentID"> <summary> The Category Parent ID. </summary> </member> <member name="P:CMS.PortalEngine.WebPartCategoryInfo.CategoryName"> <summary> The Category Name. </summary> </member> <member name="P:CMS.PortalEngine.WebPartCategoryInfo.CategoryGUID"> <summary> Category GUID. </summary> </member> <member name="P:CMS.PortalEngine.WebPartCategoryInfo.CategoryLastModified"> <summary> Object last modified. </summary> </member> <member name="P:CMS.PortalEngine.WebPartCategoryInfo.CategoryImagePath"> <summary> Gets or sets category image path. </summary> </member> <member name="P:CMS.PortalEngine.WebPartCategoryInfo.CategoryChildCount"> <summary> Gets or sets category children count. </summary> </member> <member name="P:CMS.PortalEngine.WebPartCategoryInfo.CategoryWebPartChildCount"> <summary> Gets or sets category webpart children count. </summary> </member> <member name="P:CMS.PortalEngine.WebPartCategoryInfo.CategoryPath"> <summary> Gets or sets category path. </summary> </member> <member name="P:CMS.PortalEngine.WebPartCategoryInfo.CategoryLevel"> <summary> Gets or sets category level. </summary> </member> <member name="P:CMS.PortalEngine.WebPartCategoryInfo.ValidateCodeName"> <summary> If true, the code name is validated upon saving. </summary> </member> <member name="T:CMS.PortalEngine.WebPartCategoryInfoProvider"> <summary> Provides access to information about WebPartCategory. </summary> </member> <member name="M:CMS.PortalEngine.WebPartCategoryInfoProvider.#ctor"> <summary> Constructor. </summary> </member> <member name="M:CMS.PortalEngine.WebPartCategoryInfoProvider.GetCategories"> <summary> Returns all web part categories. </summary> </member> <member name="M:CMS.PortalEngine.WebPartCategoryInfoProvider.GetCategories(System.Int32)"> <summary> Gets dataset with fist level categories in specified category. </summary> <param name="parentCategoryId">ID of category to retrieve sub-categories</param> </member> <member name="M:CMS.PortalEngine.WebPartCategoryInfoProvider.SetWebPartCategoryInfo(CMS.PortalEngine.WebPartCategoryInfo)"> <summary> Sets the specified WebPartCategory data. </summary> <param name="categoryObj">WebPartCategory data object</param> </member> <member name="M:CMS.PortalEngine.WebPartCategoryInfoProvider.GetWebPartCategoryInfoByGUID(System.Guid)"> <summary> Returns object with specified GUID. </summary> <param name="guid">Object GUID</param> </member> <member name="M:CMS.PortalEngine.WebPartCategoryInfoProvider.GetWebPartCategoryInfoByCodeName(System.String)"> <summary> Returns the WebPartCategoryInfo structure by the code name. </summary> <param name="categoryName">Category code name</param> </member> <member name="M:CMS.PortalEngine.WebPartCategoryInfoProvider.GetWebPartCategoryInfoById(System.Int32)"> <summary> Returns the WebPartCategoryInfo structure for the specified layout. </summary> <param name="categoryId">Id of the category to retrieve</param> </member> <member name="M:CMS.PortalEngine.WebPartCategoryInfoProvider.DeleteCategoryInfo(CMS.PortalEngine.WebPartCategoryInfo)"> <summary> Delete specified WebPartCategory. </summary> <param name="webPartCategoryInfo">WebPartCategory object</param> </member> <member name="M:CMS.PortalEngine.WebPartCategoryInfoProvider.DeleteCategoryInfo(System.Int32)"> <summary> Delete specified WebPartCategory. </summary> <param name="categoryId">Layout id to delete</param> </member> <member name="M:CMS.PortalEngine.WebPartCategoryInfoProvider.GetCategoryPath(System.Int32)"> <summary> Returns the DataSet of all the categories on the path to the given category. </summary> <param name="categoryId">Category ID</param> </member> <member name="M:CMS.PortalEngine.WebPartCategoryInfoProvider.UpdateCategoryChildCount(System.Int32,System.Int32)"> <summary> Updates the child categories count of category. </summary> <param name="originalParentID">Original parent ID</param> <param name="newParentID">New parent ID</param> </member> <member name="M:CMS.PortalEngine.WebPartCategoryInfoProvider.UpdateCategoryWebPartChildCount(System.Int32,System.Int32)"> <summary> Updates the child webparts count of category. </summary> <param name="originalParentID">Original parent ID</param> <param name="newParentID">New parent ID</param> </member> <member name="M:CMS.PortalEngine.WebPartCategoryInfoProvider.RefreshDataCounts"> <summary> Updates all counts for all sub-objects. </summary> </member> <member name="M:CMS.PortalEngine.WebPartCategoryInfoProvider.GetCategoriesAndWebparts(System.String,System.String,System.Int32,System.String)"> <summary> Returns dataset with categories and webparts </summary> <param name="where">Where condition</param> <param name="orderBy">Order by expression</param> <param name="topN">Top N</param> <param name="columns">Columns to select, null or empty returns all columns</param> </member> <member name="M:CMS.PortalEngine.WebPartCategoryInfoProvider.RefreshObjectsCounts"> <summary> Updates all counts for all sub-objects. </summary> </member> <member name="M:CMS.PortalEngine.WebPartCategoryInfoProvider.GetCategoriesInternal"> <summary> Returns all web part categories </summary> </member> <member name="M:CMS.PortalEngine.WebPartCategoryInfoProvider.GetCategoriesAndWebpartsInternal(System.String,System.String,System.Int32,System.String)"> <summary> Returns dataset with categories and webparts </summary> <param name="where">Where condition</param> <param name="orderBy">Order by expression</param> <param name="topN">Top N</param> <param name="columns">Columns to select, null or empty returns all columns</param> </member> <member name="M:CMS.PortalEngine.WebPartCategoryInfoProvider.GetCategoriesInternal(System.Int32)"> <summary> Gets dataset with fist level categories in specified category. </summary> <param name="parentCategoryId">ID of category to retrieve sub-categories</param> </member> <member name="M:CMS.PortalEngine.WebPartCategoryInfoProvider.SetWebPartCategoryInfoInternal(CMS.PortalEngine.WebPartCategoryInfo)"> <summary> Sets the specified WebPartCategory data. </summary> <param name="categoryObj">WebPartCategory data object</param> </member> <member name="M:CMS.PortalEngine.WebPartCategoryInfoProvider.GetWebPartCategoryInfoInternal(System.Guid)"> <summary> Returns object with specified GUID. </summary> <param name="guid">Object GUID</param> </member> <member name="M:CMS.PortalEngine.WebPartCategoryInfoProvider.GetWebPartCategoryInfoInternal(System.String)"> <summary> Returns the WebPartCategoryInfo structure by the code name. </summary> <param name="categoryName">Category code name</param> </member> <member name="M:CMS.PortalEngine.WebPartCategoryInfoProvider.GetWebPartCategoryInfoInternal(System.Int32)"> <summary> Returns the WebPartCategoryInfo structure for the specified layout. </summary> <param name="categoryId">Id of the category to retrieve</param> </member> <member name="M:CMS.PortalEngine.WebPartCategoryInfoProvider.DeleteCategoryInfoInternal(CMS.PortalEngine.WebPartCategoryInfo)"> <summary> Delete specified WebPartCategory. </summary> <param name="webPartCategoryInfo">WebPartCategory object</param> </member> <member name="M:CMS.PortalEngine.WebPartCategoryInfoProvider.GetCategoryPathInternal(System.Int32)"> <summary> Returns the DataSet of all the categories on the path to the given category. </summary> <param name="categoryId">Category ID</param> </member> <member name="M:CMS.PortalEngine.WebPartCategoryInfoProvider.UpdateCategoryChildCountInternal(System.Int32,System.Int32)"> <summary> Updates the child categories count of category. </summary> <param name="originalParentID">Original parent ID</param> <param name="newParentID">New parent ID</param> </member> <member name="M:CMS.PortalEngine.WebPartCategoryInfoProvider.UpdateCategoryWebPartChildCountInternal(System.Int32,System.Int32)"> <summary> Updates the child webparts count of category. </summary> <param name="originalParentID">Original parent ID</param> <param name="newParentID">New parent ID</param> </member> <member name="M:CMS.PortalEngine.WebPartCategoryInfoProvider.RefreshDataCountsInternal"> <summary> Updates all counts for all sub-objects. </summary> </member> <member name="T:CMS.PortalEngine.WebPartContainerInfo"> <summary> WebPartContainerInfo data container class. </summary> </member> <member name="F:CMS.PortalEngine.WebPartContainerInfo.OBJECT_TYPE"> <summary> Object type </summary> </member> <member name="F:CMS.PortalEngine.WebPartContainerInfo.TYPEINFO"> <summary> Type information. </summary> </member> <member name="M:CMS.PortalEngine.WebPartContainerInfo.DeleteObject"> <summary> Deletes the object using appropriate provider. </summary> </member> <member name="M:CMS.PortalEngine.WebPartContainerInfo.SetObject"> <summary> Updates the object using appropriate provider. </summary> </member> <member name="M:CMS.PortalEngine.WebPartContainerInfo.#ctor"> <summary> Constructor - Creates an empty WebPartContainerInfo object. </summary> </member> <member name="M:CMS.PortalEngine.WebPartContainerInfo.#ctor(System.Data.DataRow)"> <summary> Constructor - Creates a new WebPartContainerInfo object from the given DataRow. </summary> </member> <member name="M:CMS.PortalEngine.WebPartContainerInfo.GetThemePath"> <summary> Gets the theme path for the object </summary> </member> <member name="M:CMS.PortalEngine.WebPartContainerInfo.GetPermissionName(CMS.DataEngine.PermissionsEnum)"> <summary> Converts PermissionEnum to permission codename which will be checked when CheckPermission() is called. </summary> <param name="permission">Permission to convert to string</param> </member> <member name="M:CMS.PortalEngine.WebPartContainerInfo.CheckPermissionsInternal(CMS.DataEngine.PermissionsEnum,System.String,CMS.Base.IUserInfo,System.Boolean)"> <summary> Checks the permissions of the object. </summary> <param name="permission">Permission type</param> <param name="siteName">Name of the site</param> <param name="userInfo">UserInfo object</param> <param name="exceptionOnFailure">If true, PermissionCheckException is thrown whenever a permission check fails</param> </member> <member name="M:CMS.PortalEngine.WebPartContainerInfo.InsertAsCloneInternal(CMS.DataEngine.CloneSettings,CMS.DataEngine.CloneResult,CMS.DataEngine.BaseInfo)"> <summary> Inserts cloned object to DB. </summary> <param name="settings">Cloning settings</param> <param name="result">Cloning result</param> <param name="originalObject">Original source BaseInfo (object being cloned)</param> </member> <member name="M:CMS.PortalEngine.WebPartContainerInfo.GetVirtualFileRelativePath(System.String,System.String)"> <summary> Returns virtual relative path for specific column. </summary> <param name="externalColumnName">External column name</param> <param name="versionGuid">Version GUID. If not defined physical path is generated</param> </member> <member name="M:CMS.PortalEngine.WebPartContainerInfo.RegisterExternalColumns"> <summary> Returns path to externally stored before/after codes. </summary> </member> <member name="P:CMS.PortalEngine.WebPartContainerInfo.ContainerTextBefore"> <summary> Container text before. </summary> </member> <member name="P:CMS.PortalEngine.WebPartContainerInfo.ContainerTextAfter"> <summary> Container text after. </summary> </member> <member name="P:CMS.PortalEngine.WebPartContainerInfo.ContainerCSS"> <summary> Container CSS styles. </summary> </member> <member name="P:CMS.PortalEngine.WebPartContainerInfo.ContainerName"> <summary> Container name. </summary> </member> <member name="P:CMS.PortalEngine.WebPartContainerInfo.ContainerID"> <summary> Container id. </summary> </member> <member name="P:CMS.PortalEngine.WebPartContainerInfo.ContainerDisplayName"> <summary> Container display name. </summary> </member> <member name="P:CMS.PortalEngine.WebPartContainerInfo.ContainerGUID"> <summary> Container GUID. </summary> </member> <member name="P:CMS.PortalEngine.WebPartContainerInfo.ContainerLastModified"> <summary> Object last modified. </summary> </member> <member name="P:CMS.PortalEngine.WebPartContainerInfo.UsesExternalStorage"> <summary> Indicates whether the theme path points at an external storage. </summary> </member> <member name="T:CMS.PortalEngine.WebPartContainerInfoProvider"> <summary> Class providing WebPartContainerInfo management. </summary> </member> <member name="F:CMS.PortalEngine.WebPartContainerInfoProvider.WP_CHAR"> <summary> Specifies the character that is used as a placeholder in the web part container editing </summary> </member> <member name="M:CMS.PortalEngine.WebPartContainerInfoProvider.#ctor"> <summary> Constructor. </summary> </member> <member name="M:CMS.PortalEngine.WebPartContainerInfoProvider.GetWebPartContainerInfoByGUID(System.Guid)"> <summary> Returns object with specified GUID. </summary> <param name="containerGuid">Object GUID</param> </member> <member name="M:CMS.PortalEngine.WebPartContainerInfoProvider.GetWebPartContainerInfo(System.String)"> <summary> Returns the WebPartContainerInfo structure for the specified webPartContainer. </summary> <param name="containerName">Name of webpart container</param> </member> <member name="M:CMS.PortalEngine.WebPartContainerInfoProvider.GetWebPartContainerInfo(System.Int32)"> <summary> Returns the WebPartContainerInfo structure for the specified webPartContainer. </summary> <param name="containerId">WebPartContainer id</param> </member> <member name="M:CMS.PortalEngine.WebPartContainerInfoProvider.SetWebPartContainerInfo(CMS.PortalEngine.WebPartContainerInfo)"> <summary> Sets (updates or inserts) specified webPartContainer. </summary> <param name="webPartContainer">WebPartContainer to set</param> </member> <member name="M:CMS.PortalEngine.WebPartContainerInfoProvider.DeleteWebPartContainerInfo(CMS.PortalEngine.WebPartContainerInfo)"> <summary> Deletes specified webPartContainer. </summary> <param name="webPartContainerObj">WebPartContainer object</param> </member> <member name="M:CMS.PortalEngine.WebPartContainerInfoProvider.DeleteWebPartContainerInfo(System.Int32)"> <summary> Deletes specified webPartContainer. </summary> <param name="webPartContainerId">WebPartContainer id</param> </member> <member name="M:CMS.PortalEngine.WebPartContainerInfoProvider.GetContainers"> <summary> Returns all web part containers. </summary> </member> <member name="M:CMS.PortalEngine.WebPartContainerInfoProvider.Clear(System.Boolean)"> <summary> Clear hashtable. </summary> <param name="logTasks">If true, web farm tasks are logged</param> </member> <member name="M:CMS.PortalEngine.WebPartContainerInfoProvider.RemoveFromHash(System.String)"> <summary> Remove from hash table. </summary> <param name="dataText">Data text</param> </member> <member name="M:CMS.PortalEngine.WebPartContainerInfoProvider.GetContainersInternal"> <summary> Returns all web part containers. </summary> </member> <member name="M:CMS.PortalEngine.WebPartContainerInfoProvider.GetWebPartContainerInfoInternal(System.Guid)"> <summary> Returns WebPartContainer object with specified GUID. </summary> <param name="containerGuid">Object GUID</param> </member> <member name="M:CMS.PortalEngine.WebPartContainerInfoProvider.GetWebPartContainerInfoInternal(System.String)"> <summary> Returns WebPartContainer object with specified code name. </summary> <param name="containerName">Object name</param> </member> <member name="M:CMS.PortalEngine.WebPartContainerInfoProvider.GetWebPartContainerInfoInternal(System.Int32)"> <summary> Returns Web part container object with specified ID. </summary> <param name="containerId">Object ID</param> </member> <member name="M:CMS.PortalEngine.WebPartContainerInfoProvider.SetWebPartContainerInfoInternal(CMS.PortalEngine.WebPartContainerInfo)"> <summary> Sets (updates or inserts) specified web part container. </summary> <param name="webPartContainer">Web part container to set</param> </member> <member name="M:CMS.PortalEngine.WebPartContainerInfoProvider.DeleteWebPartContainerInfoInternal(CMS.PortalEngine.WebPartContainerInfo)"> <summary> Deletes specified webPartContainer. </summary> <param name="webPartContainerObj">WebPartContainer object</param> </member> <member name="P:CMS.PortalEngine.WebPartContainerInfoProvider.WebPartContainersDirectory"> <summary> Gets the WebPart containers directory path. </summary> </member> <member name="P:CMS.PortalEngine.WebPartContainerInfoProvider.StoreWebPartContainersInExternalStorage"> <summary> Gets or sets the value that indicates whether WebPart containers should be stored externally. </summary> </member> <member name="T:CMS.PortalEngine.WebPartContainerSiteInfo"> <summary> WebPartContainerSiteInfo data container class. </summary> </member> <member name="F:CMS.PortalEngine.WebPartContainerSiteInfo.OBJECT_TYPE"> <summary> Object type </summary> </member> <member name="F:CMS.PortalEngine.WebPartContainerSiteInfo.TYPEINFO"> <summary> Type information. </summary> </member> <member name="M:CMS.PortalEngine.WebPartContainerSiteInfo.DeleteObject"> <summary> Deletes the object using appropriate provider. </summary> </member> <member name="M:CMS.PortalEngine.WebPartContainerSiteInfo.SetObject"> <summary> Updates the object using appropriate provider. </summary> </member> <member name="M:CMS.PortalEngine.WebPartContainerSiteInfo.#ctor"> <summary> Constructor - Creates an empty WebPartContainerSiteInfo object. </summary> </member> <member name="M:CMS.PortalEngine.WebPartContainerSiteInfo.#ctor(System.Data.DataRow)"> <summary> Constructor - Creates a new WebPartContainerSiteInfo object from the given DataRow. </summary> </member> <member name="P:CMS.PortalEngine.WebPartContainerSiteInfo.SiteID"> <summary> Site ID. </summary> </member> <member name="P:CMS.PortalEngine.WebPartContainerSiteInfo.ContainerID"> <summary> Container ID. </summary> </member> <member name="T:CMS.PortalEngine.WebPartContainerSiteInfoProvider"> <summary> Class providing WebPartContainerSiteInfo management. </summary> </member> <member name="M:CMS.PortalEngine.WebPartContainerSiteInfoProvider.GetWebPartContainerSiteInfo(System.Int32,System.Int32)"> <summary> Returns the WebPartContainerSiteInfo structure for the specified webPartContainerSite. </summary> <param name="siteId">SiteID</param> <param name="containerId">ContainerID</param> </member> <member name="M:CMS.PortalEngine.WebPartContainerSiteInfoProvider.SetWebPartContainerSiteInfo(CMS.PortalEngine.WebPartContainerSiteInfo)"> <summary> Sets (updates or inserts) specified webPartContainerSite. </summary> <param name="webPartContainerSite">WebPartContainerSite to set</param> </member> <member name="M:CMS.PortalEngine.WebPartContainerSiteInfoProvider.DeleteWebPartContainerSiteInfo(CMS.PortalEngine.WebPartContainerSiteInfo)"> <summary> Deletes specified webPartContainerSite. </summary> <param name="infoObj">WebPartContainerSite object</param> </member> <member name="M:CMS.PortalEngine.WebPartContainerSiteInfoProvider.DeleteWebPartContainerSiteInfo(System.Int32,System.Int32)"> <summary> Deletes specified webPartContainerSite. </summary> <param name="siteId">SiteID</param> <param name="containerId">ContainerID</param> </member> <member name="M:CMS.PortalEngine.WebPartContainerSiteInfoProvider.AddContainerToSite(System.Int32,System.Int32)"> <summary> Add specified web part container to the site. </summary> <param name="containerId">Container ID</param> <param name="siteId">Site ID</param> </member> <member name="M:CMS.PortalEngine.WebPartContainerSiteInfoProvider.AddContainerToSite(CMS.PortalEngine.WebPartContainerInfo,CMS.SiteProvider.SiteInfo)"> <summary> Add specified web part container to the site. </summary> <param name="ci">Web part container info object</param> <param name="si">Site info object</param> </member> <member name="M:CMS.PortalEngine.WebPartContainerSiteInfoProvider.RemoveContainerFromSite(System.Int32,System.Int32)"> <summary> Remove specified web part container from site. </summary> <param name="containerId">Container ID</param> <param name="siteId">Site ID</param> </member> <member name="M:CMS.PortalEngine.WebPartContainerSiteInfoProvider.GetWebPartContainerSiteInfos"> <summary> Returns all web part container -- site bindings. </summary> </member> <member name="M:CMS.PortalEngine.WebPartContainerSiteInfoProvider.GetWebPartContainerSiteInfoInternal(System.Int32,System.Int32)"> <summary> Returns the WebPartContainerSiteInfo structure for the specified webPartContainerSite. </summary> <param name="siteId">SiteID</param> <param name="containerId">ContainerID</param> </member> <member name="M:CMS.PortalEngine.WebPartContainerSiteInfoProvider.SetWebPartContainerSiteInfoInternal(CMS.PortalEngine.WebPartContainerSiteInfo)"> <summary> Sets (updates or inserts) specified webPartContainerSite. </summary> <param name="webPartContainerSite">WebPartContainerSite to set</param> </member> <member name="M:CMS.PortalEngine.WebPartContainerSiteInfoProvider.DeleteWebPartContainerSiteInfoInternal(CMS.PortalEngine.WebPartContainerSiteInfo)"> <summary> Deletes specified webPartContainerSite. </summary> <param name="infoObj">WebPartContainerSite object</param> </member> <member name="M:CMS.PortalEngine.WebPartContainerSiteInfoProvider.DeleteWebPartContainerSiteInfoInternal(System.Int32,System.Int32)"> <summary> Deletes specified webPartContainerSite. </summary> <param name="siteId">SiteID</param> <param name="containerId">ContainerID</param> </member> <member name="M:CMS.PortalEngine.WebPartContainerSiteInfoProvider.AddContainerToSiteInternal(System.Int32,System.Int32)"> <summary> Add specified web part container to the site. </summary> <param name="containerId">Container ID</param> <param name="siteId">Site ID</param> </member> <member name="M:CMS.PortalEngine.WebPartContainerSiteInfoProvider.AddContainerToSiteInternal(CMS.PortalEngine.WebPartContainerInfo,CMS.SiteProvider.SiteInfo)"> <summary> Add specified web part container to the site. </summary> <param name="ci">Web part container info object</param> <param name="si">Site info object</param> </member> <member name="M:CMS.PortalEngine.WebPartContainerSiteInfoProvider.RemoveContainerFromSiteInternal(System.Int32,System.Int32)"> <summary> Remove specified web part container from site. </summary> <param name="containerId">Container ID</param> <param name="siteId">Site ID</param> </member> <member name="T:CMS.PortalEngine.WebPartInfo"> <summary> WebPart info data container class. </summary> </member> <member name="F:CMS.PortalEngine.WebPartInfo.OBJECT_TYPE"> <summary> Object type </summary> </member> <member name="F:CMS.PortalEngine.WebPartInfo.DEFAULT_CONFIG_WEBPARTNAME"> <summary> Name of the web part in the web part default configuration </summary> </member> <member name="F:CMS.PortalEngine.WebPartInfo.DEFAULT_CONFIG_ZONENAME"> <summary> Name of the web part zone in the web part default configuration </summary> </member> <member name="F:CMS.PortalEngine.WebPartInfo.TYPEINFO"> <summary> Type information. </summary> </member> <member name="F:CMS.PortalEngine.WebPartInfo.mFormInfo"> <summary> Form info definition </summary> </member> <member name="F:CMS.PortalEngine.WebPartInfo.mDefaultConfiguration"> <summary> Default web part configuration </summary> </member> <member name="F:CMS.PortalEngine.WebPartInfo.DEFAULT_CONFIG_INSTANCEGUID"> <summary> Name of the web part in the web part default configuration </summary> </member> <member name="M:CMS.PortalEngine.WebPartInfo.DeleteObject"> <summary> Deletes the object using appropriate provider. </summary> </member> <member name="M:CMS.PortalEngine.WebPartInfo.SetObject"> <summary> Updates the object using appropriate provider. </summary> </member> <member name="M:CMS.PortalEngine.WebPartInfo.RegisterProperties"> <summary> Register the properties of the object </summary> </member> <member name="M:CMS.PortalEngine.WebPartInfo.GetWebPartFormInfo"> <summary> Gets the web part info for current web part </summary> <returns></returns> </member> <member name="M:CMS.PortalEngine.WebPartInfo.HasDefaultConfiguration"> <summary> Returns true if the web part has the default configuration available </summary> </member> <member name="M:CMS.PortalEngine.WebPartInfo.ResetDefaultConfiguration"> <summary> Resets the default web part configuration to the original state </summary> </member> <member name="M:CMS.PortalEngine.WebPartInfo.RemoveDefaultConfiguration"> <summary> Removes the default configuration from the web part </summary> </member> <member name="M:CMS.PortalEngine.WebPartInfo.EnsureDefaultConfiguration"> <summary> Ensures the default configuration within the web part </summary> </member> <member name="M:CMS.PortalEngine.WebPartInfo.GetVirtualPageTemplate"> <summary> Gets the virtual page template provided by this object </summary> </member> <member name="M:CMS.PortalEngine.WebPartInfo.GetThemePath"> <summary> Gets the theme path for the object </summary> </member> <member name="M:CMS.PortalEngine.WebPartInfo.InsertAsCloneInternal(CMS.DataEngine.CloneSettings,CMS.DataEngine.CloneResult,CMS.DataEngine.BaseInfo)"> <summary> Inserts cloned object to DB. </summary> <param name="settings">Cloning settings</param> <param name="result">Cloning result</param> <param name="originalObject">Original source BaseInfo (object being cloned)</param> </member> <member name="M:CMS.PortalEngine.WebPartInfo.RemoveObjectDependencies(System.Boolean,System.Boolean)"> <summary> Removes web part dependencies. </summary> </member> <member name="M:CMS.PortalEngine.WebPartInfo.#ctor(CMS.PortalEngine.WebPartInfo,System.Boolean)"> <summary> Constructor, Creates a new WebPartInfo object from the given DataClass. </summary> <param name="wi">Source WebPart info</param> <param name="keepSourceData">If true, source data are kept in the object</param> </member> <member name="M:CMS.PortalEngine.WebPartInfo.#ctor"> <summary> Constructor, creates an empty WebPartInfo structure. </summary> </member> <member name="M:CMS.PortalEngine.WebPartInfo.#ctor(System.Data.DataRow)"> <summary> Constructor, creates an empty WebPartInfo object from the given DataRow data. </summary> <param name="dr">Datarow with the class info data</param> </member> <member name="M:CMS.PortalEngine.WebPartInfo.LoadDefaultData"> <summary> Loads the default data to the object. </summary> </member> <member name="M:CMS.PortalEngine.WebPartInfo.GetUsageObjectTypes"> <summary> Gets the list of object types that may use the web part </summary> </member> <member name="M:CMS.PortalEngine.WebPartInfo.GetUsages"> <summary> Gets the objects using the web part as a query with result columns ObjectType, ObjectID. </summary> </member> <member name="M:CMS.PortalEngine.WebPartInfo.GetWebPartChildCondition(System.String)"> <summary> Creates where condition to find current web part as a parent (usable for inherited web parts and widgets) </summary> <param name="columnName">Parent ID column name</param> </member> <member name="M:CMS.PortalEngine.WebPartInfo.GetWebPartSearchCondition(System.String,System.String)"> <summary> Creates where condition to find current web part in form definition (usable for page template, MVT variants and CP variants) </summary> <param name="columnName">Web part definition column name</param> <param name="searchPattern">Search pattern</param> </member> <member name="M:CMS.PortalEngine.WebPartInfo.AddTypeToUsageQuery(CMS.DataEngine.MultiObjectQuery,System.String,System.String,CMS.DataEngine.IWhereCondition)"> <summary> Adds type to query to get all usages of current web part </summary> <param name="query">Multi object query</param> <param name="objectType">Object type to add to search in</param> <param name="idColumn">ID column name of the object</param> <param name="condition">Condition how to find the current web part</param> </member> <member name="P:CMS.PortalEngine.WebPartInfo.WebPartID"> <summary> The WebPart ID. </summary> </member> <member name="P:CMS.PortalEngine.WebPartInfo.WebPartName"> <summary> The WebPartName. </summary> </member> <member name="P:CMS.PortalEngine.WebPartInfo.WebPartDisplayName"> <summary> The WebPartDisplayName. </summary> </member> <member name="P:CMS.PortalEngine.WebPartInfo.WebPartDescription"> <summary> The WebPartDescription. </summary> </member> <member name="P:CMS.PortalEngine.WebPartInfo.WebPartCSS"> <summary> The WebPartCSS. </summary> </member> <member name="P:CMS.PortalEngine.WebPartInfo.WebPartProperties"> <summary> The WebPartProperties. </summary> </member> <member name="P:CMS.PortalEngine.WebPartInfo.WebPartDefaultValues"> <summary> Web part default properties. </summary> </member> <member name="P:CMS.PortalEngine.WebPartInfo.WebPartFileName"> <summary> The WebPartFileName. </summary> </member> <member name="P:CMS.PortalEngine.WebPartInfo.WebPartCategoryID"> <summary> The WebPartCategoryID. </summary> </member> <member name="P:CMS.PortalEngine.WebPartInfo.WebPartType"> <summary> Gets or sets the web part type. </summary> </member> <member name="P:CMS.PortalEngine.WebPartInfo.WebPartParentID"> <summary> The WebPartParentID. </summary> </member> <member name="P:CMS.PortalEngine.WebPartInfo.WebPartDocumentation"> <summary> Webpart documentation field. </summary> </member> <member name="P:CMS.PortalEngine.WebPartInfo.WebPartGUID"> <summary> WebPart GUID. </summary> </member> <member name="P:CMS.PortalEngine.WebPartInfo.WebPartLastModified"> <summary> Object last modified. </summary> </member> <member name="P:CMS.PortalEngine.WebPartInfo.WebPartLoadGeneration"> <summary> Gets or sets the webpart load generation. </summary> </member> <member name="P:CMS.PortalEngine.WebPartInfo.WebPartResourceID"> <summary> Web part resource (module) ID. </summary> </member> <member name="P:CMS.PortalEngine.WebPartInfo.WebPartSkipInsertProperties"> <summary> Indicates whether the web part properties dialog should be displayed when inserting a web part to the page. </summary> </member> <member name="P:CMS.PortalEngine.WebPartInfo.WebPartThumbnailGUID"> <summary> WebPart thumbnail metafile GUID. </summary> </member> <member name="P:CMS.PortalEngine.WebPartInfo.WebPartIconClass"> <summary> WebPart icon class defining the web part thumbnail. </summary> </member> <member name="P:CMS.PortalEngine.WebPartInfo.WebPartDefaultConfiguration"> <summary> Gets or sets the web part default configuration </summary> </member> <member name="P:CMS.PortalEngine.WebPartInfo.DefaultConfiguration"> <summary> Template structure instance. </summary> </member> <member name="P:CMS.PortalEngine.WebPartInfo.UsesExternalStorage"> <summary> Indicates whether the theme path points at an external storage. </summary> </member> <member name="T:CMS.PortalEngine.WebPartInfoProvider"> <summary> Class to provide the WebPartInfo management. </summary> </member> <member name="M:CMS.PortalEngine.WebPartInfoProvider.#ctor"> <summary> Constructor </summary> </member> <member name="M:CMS.PortalEngine.WebPartInfoProvider.GetWebPartInfoByGUID(System.Guid)"> <summary> Returns object with specified GUID. </summary> <param name="guid">Object GUID</param> </member> <member name="M:CMS.PortalEngine.WebPartInfoProvider.GetAllWebParts(System.Int32)"> <summary> Gets all WebParts in specified WebPartCategory. </summary> <param name="webPartCategoryId">ID of specified WebPartCategory</param> </member> <member name="M:CMS.PortalEngine.WebPartInfoProvider.GetWebParts"> <summary> Returns all web parts; </summary> </member> <member name="M:CMS.PortalEngine.WebPartInfoProvider.SetWebPartInfo(CMS.PortalEngine.WebPartInfo)"> <summary> Sets the specified WebPart info data. </summary> <param name="infoObj">CultureInfo object to set (save as new or update existing)</param> </member> <member name="M:CMS.PortalEngine.WebPartInfoProvider.GetWebPartInfo(System.String)"> <summary> Returns WebPartInfo object for specified WebPartName. </summary> <param name="webPartName">Name of WebPart to retrieve</param> </member> <member name="M:CMS.PortalEngine.WebPartInfoProvider.GetWebPartInfo(System.Int32)"> <summary> Returns WebPartInfo object for specified WebPartID. </summary> <param name="webPartId">ID of WebPart to retrieve</param> </member> <member name="M:CMS.PortalEngine.WebPartInfoProvider.DeleteWebPartInfo(CMS.PortalEngine.WebPartInfo)"> <summary> Delete specified WebPart. </summary> <param name="wi">WebPart object</param> </member> <member name="M:CMS.PortalEngine.WebPartInfoProvider.DeleteWebPartInfo(System.String)"> <summary> Delete specified WebPart. </summary> <param name="webPartName">Name of the WebPart to delete</param> </member> <member name="M:CMS.PortalEngine.WebPartInfoProvider.DeleteWebPartInfo(System.Int32)"> <summary> Delete specified WebPart. </summary> <param name="webPartId">ID of the WebPart to delete</param> </member> <member name="M:CMS.PortalEngine.WebPartInfoProvider.GetChildWebParts(System.Int32)"> <summary> Returns DataSet with all webparts which are inherited from selected web part. </summary> <param name="webPartId">Web part ID</param> </member> <member name="M:CMS.PortalEngine.WebPartInfoProvider.DeleteChildWebParts(System.Int32)"> <summary> Deletes all the child web parts of the specified web part. </summary> <param name="webPartId">Web part ID</param> </member> <member name="M:CMS.PortalEngine.WebPartInfoProvider.GetBaseWebPart(CMS.PortalEngine.WebPartInfo)"> <summary> Gets the base web part for the specified web part. </summary> <param name="wpi">Web part</param> </member> <member name="M:CMS.PortalEngine.WebPartInfoProvider.GetBaseWebPart(System.String)"> <summary> Gets the base web part for the specified web part. </summary> <param name="webPartName">Web part name</param> </member> <member name="M:CMS.PortalEngine.WebPartInfoProvider.GetWebPartUrl(CMS.PortalEngine.WebPartInfo,System.Boolean)"> <summary> Returns URL to specified WebPart. </summary> <param name="partInfo">Web part info object</param> <param name="resolveUrl">If true, the URL is resolved</param> </member> <member name="M:CMS.PortalEngine.WebPartInfoProvider.GetWebPartUrl(System.String,System.Boolean)"> <summary> Returns URL to specified WebPart. </summary> <param name="codeName">Web part code name</param> <param name="resolveUrl">Resolve the URL</param> </member> <member name="M:CMS.PortalEngine.WebPartInfoProvider.GetWebPartPhysicalPath(System.String)"> <summary> Returns webpart physical path. </summary> <param name="webpartPath">Webpart path</param> </member> <member name="M:CMS.PortalEngine.WebPartInfoProvider.GetFullPhysicalPath(CMS.PortalEngine.WebPartInfo,System.String)"> <summary> Returns full path of the web part. </summary> <param name="partInfo">Web part info object</param> <param name="webFullPath">Full path to the root of the web project (e.g. c:\WebProject\)</param> </member> <member name="M:CMS.PortalEngine.WebPartInfoProvider.GetFullPhysicalPath(System.String,System.Int32,System.String)"> <summary> Returns full path of the web part. </summary> <param name="webPartFileName">Web part file name</param> <param name="parentWebPartId">Parent web part ID</param> <param name="webFullPath">Full path to the root of the web project (e.g. c:\WebProject\)</param> </member> <member name="M:CMS.PortalEngine.WebPartInfoProvider.LoadAllWebParts"> <summary> Loads all the web parts into the hashtable. </summary> </member> <member name="M:CMS.PortalEngine.WebPartInfoProvider.GetVirtualWebPartUrl(CMS.PortalEngine.IPageInfo,CMS.PortalEngine.WebPartInstance,System.Int32,CMS.PortalEngine.WebPartInfo)"> <summary> Returns virtual URL to the web part. </summary> <param name="cacheMinutes">Cache minutes</param> <param name="part">Web part instance</param> <param name="pi">IPageInfo object</param> <param name="wpi">Web part info</param> </member> <member name="M:CMS.PortalEngine.WebPartInfoProvider.GetWebPartsInternal"> <summary> Returns all web parts; </summary> </member> <member name="M:CMS.PortalEngine.WebPartInfoProvider.GetWebPartInfoInternal(System.Int32)"> <summary> Returns WebPartInfo object for specified WebPartID. </summary> <param name="webPartId">ID of WebPart to retrieve</param> </member> <member name="M:CMS.PortalEngine.WebPartInfoProvider.GetWebPartInfoInternal(System.String)"> <summary> Returns WebPartInfo object for specified WebPartName. </summary> <param name="webPartName">Name of WebPart to retrieve</param> </member> <member name="M:CMS.PortalEngine.WebPartInfoProvider.GetWebPartInfoInternal(System.Guid)"> <summary> Returns object with specified GUID. </summary> <param name="guid">Object GUID</param> </member> <member name="M:CMS.PortalEngine.WebPartInfoProvider.SetWebPartInfoInternal(CMS.PortalEngine.WebPartInfo)"> <summary> Sets the specified WebPart info data. </summary> <param name="infoObj">CultureInfo object to set (save as new or update existing)</param> </member> <member name="M:CMS.PortalEngine.WebPartInfoProvider.DeleteWebPartInfoInternal(CMS.PortalEngine.WebPartInfo)"> <summary> Delete specified WebPart. </summary> <param name="wi">WebPart object</param> </member> <member name="M:CMS.PortalEngine.WebPartInfoProvider.GetChildWebPartsInternal(System.Int32)"> <summary> Returns DataSet with all webparts which are inherited from selected web part. </summary> <param name="webPartId">Web part ID</param> </member> <member name="M:CMS.PortalEngine.WebPartInfoProvider.GenerateWebPartCode(System.Int32,System.String,System.String@,System.String@)"> <summary> Generates the web part code. </summary> <param name="webpartId">Web part ID</param> <param name="baseControl">Base control nested within the web part</param> <param name="ascx">Returning ASCX code</param> <param name="code">Returning code behind</param> </member> <member name="M:CMS.PortalEngine.WebPartInfoProvider.GenerateWebPartCode(CMS.PortalEngine.WebPartInfo,System.String,System.String@,System.String@,System.String@)"> <summary> Generates the web part code. </summary> <param name="wpi">Web part info</param> <param name="baseControl">Base control nested within the web part</param> <param name="ascx">Returning ASCX code</param> <param name="code">Returning code behind</param> <param name="designer">Returning designer file</param> </member> <member name="M:CMS.PortalEngine.WebPartInfoProvider.ConvertProperties(System.String)"> <summary> CAUTION: This methods is only for special cases! This method should not be used in custom code Modifies properties format and excludes inherited properties to the separate location. </summary> <param name="allProperties">Parameter that may include inherited and system properties</param> </member> <member name="M:CMS.PortalEngine.WebPartInfoProvider.ModifyProperties(System.String@,System.String@,System.Int32)"> <summary> Modifies properties format and excludes inherited properties to the separate location. </summary> <param name="allProperties">Parameter that may include inherited and system properties</param> <param name="inheritedProperties">Parameter for inherited properties only</param> <param name="parentId">ID of parent webpart</param> </member> <member name="P:CMS.PortalEngine.WebPartInfoProvider.WebPartsDirectory"> <summary> Relative path of base directory for the web part files. </summary> </member> <member name="P:CMS.PortalEngine.WebPartInfoProvider.VirtualWebPartsDirectory"> <summary> Relative path of the directory for the web part virtual objects. </summary> </member> <member name="P:CMS.PortalEngine.WebPartInfoProvider.CodeTemplatesDirectory"> <summary> Physical path of the directory containing code templates for web part files generation. </summary> </member> <member name="T:CMS.PortalEngine.WebPartInstance"> <summary> Web part instance representation. </summary> </member> <member name="F:CMS.PortalEngine.WebPartInstance.DATASOURCE"> <summary> Represents nested data source web part name </summary> </member> <member name="M:CMS.PortalEngine.WebPartInstance.#ctor"> <summary> Constructor. </summary> </member> <member name="M:CMS.PortalEngine.WebPartInstance.#ctor(System.Xml.XmlNode)"> <summary> Constructor, initializes the instance with given XML data. </summary> </member> <member name="M:CMS.PortalEngine.WebPartInstance.FindVariant(System.Int32)"> <summary> Finds the variant with the given variant ID </summary> <param name="variantId">Variant ID</param> </member> <member name="M:CMS.PortalEngine.WebPartInstance.LoadVariants(System.Boolean,CMS.PortalEngine.VariantModeEnum,System.Int32)"> <summary> Loads all the MVT/Content personalization variants for this web part instance. </summary> <param name="forceLoad">Indicates if already loaded variants should be reloaded</param> <param name="variantMode">Specifies which variants should be loaded (MVT/ContentPersonalization/None - means both MVT+CP variants should try to load)</param> <param name="documentId">Document ID if the instance holds a widget</param> </member> <member name="M:CMS.PortalEngine.WebPartInstance.ResolvePropertyMacros(System.String)"> <summary> Resolves the property macros, replaces the {%propertyname%} macro with the property value. </summary> <param name="text">Text to resolve</param> </member> <member name="M:CMS.PortalEngine.WebPartInstance.ReplaceProperty(System.Text.RegularExpressions.Match)"> <summary> Property match evaluator to replace the found property match with the property value. </summary> <param name="m">Match found</param> </member> <member name="M:CMS.PortalEngine.WebPartInstance.Clone(System.Boolean)"> <summary> Clones the web part object (GUID stays the same when cloned). </summary> <param name="copyMacroTable">Indicates whether macro values should be cloned</param> </member> <member name="M:CMS.PortalEngine.WebPartInstance.LoadProperties(CMS.PortalEngine.WebPartInstance)"> <summary> Loads the webpart properties from given webpart. </summary> <param name="webpart">The web part instance</param> </member> <member name="M:CMS.PortalEngine.WebPartInstance.LoadProperties(System.Data.DataRow)"> <summary> Loads default values from specified DataRow to the webpart properties. </summary> <param name="dr">Datarow with properties default values</param> </member> <member name="M:CMS.PortalEngine.WebPartInstance.GetValue(System.String)"> <summary> Returns the value of the given web part property. </summary> <param name="propertyName">Property name</param> </member> <member name="M:CMS.PortalEngine.WebPartInstance.SetValue(System.String,System.Object)"> <summary> Sets the property value of the control. </summary> <param name="propertyName">Property name to set</param> <param name="value">New property value</param> </member> <member name="M:CMS.PortalEngine.WebPartInstance.ClearValues(System.String[])"> <summary> Clears the given properties </summary> <param name="propertyNames">Property names to clear</param> </member> <member name="M:CMS.PortalEngine.WebPartInstance.LoadFromXmlNode(System.Xml.XmlNode)"> <summary> Loads the web part instance from the given XML node </summary> <param name="partNode">Web part node</param> </member> <member name="M:CMS.PortalEngine.WebPartInstance.GetXmlNode(System.Xml.XmlDocument,System.String)"> <summary> Returns the XML node representing the webpart instance. </summary> <param name="doc">Parent XML document</param> <param name="nodeName">XML node name</param> </member> <member name="P:CMS.PortalEngine.WebPartInstance.XMLVersion"> <summary> Gets or sets the web part instance XML version </summary> </member> <member name="P:CMS.PortalEngine.WebPartInstance.CurrentVariantInstance"> <summary> Gets or sets the current variant webpart instance </summary> </member> <member name="P:CMS.PortalEngine.WebPartInstance.MacroTable"> <summary> Hashtable with IsMacro flags. </summary> </member> <member name="P:CMS.PortalEngine.WebPartInstance.PropertyRegEx"> <summary> Regular expression to search the property macro. </summary> </member> <member name="P:CMS.PortalEngine.WebPartInstance.ControlID"> <summary> WebPart control ID. </summary> </member> <member name="P:CMS.PortalEngine.WebPartInstance.WebPartType"> <summary> WebPart type (codename). </summary> </member> <member name="P:CMS.PortalEngine.WebPartInstance.ParentZone"> <summary> Parent web part zone. </summary> </member> <member name="P:CMS.PortalEngine.WebPartInstance.Properties"> <summary> Web part properties table. </summary> </member> <member name="P:CMS.PortalEngine.WebPartInstance.InstanceGUID"> <summary> Instance GUID to identify the web part. </summary> </member> <member name="P:CMS.PortalEngine.WebPartInstance.Removed"> <summary> Remove flag. If true, web part has been removed. Only for internal purposes. </summary> </member> <member name="P:CMS.PortalEngine.WebPartInstance.IsWidget"> <summary> Indicates if webpart instance is actually widget. </summary> </member> <member name="P:CMS.PortalEngine.WebPartInstance.IsVariant"> <summary> Indicates if webpart instance is a variant. </summary> </member> <member name="P:CMS.PortalEngine.WebPartInstance.VariantID"> <summary> Gets or sets the variant id. </summary> </member> <member name="P:CMS.PortalEngine.WebPartInstance.HasVariants"> <summary> Indicates whether the web part has any variants. </summary> </member> <member name="P:CMS.PortalEngine.WebPartInstance.VariantMode"> <summary> Gets or sets the variant mode which is used for the variants of this web part instance. </summary> </member> <member name="P:CMS.PortalEngine.WebPartInstance.Minimized"> <summary> If true, the widget is minimized. </summary> </member> <member name="P:CMS.PortalEngine.WebPartInstance.PartInstanceVariants"> <summary> Gets the part instance variant list. </summary> </member> <member name="P:CMS.PortalEngine.WebPartInstance.NestedWebParts"> <summary> Configuration for the web part data source </summary> </member> <member name="P:CMS.PortalEngine.WebPartInstance.Item(System.String)"> <summary> Gets or sets the value of the property. </summary> <param name="propertyName">Property name</param> </member> <member name="T:CMS.PortalEngine.WebPartLayoutInfo"> <summary> WebPartLayoutInfo data container class. </summary> </member> <member name="F:CMS.PortalEngine.WebPartLayoutInfo.OBJECT_TYPE"> <summary> Object type </summary> </member> <member name="F:CMS.PortalEngine.WebPartLayoutInfo.EXTERNAL_COLUMN_CODE"> <summary> External column name for WebPart Layout Code </summary> </member> <member name="F:CMS.PortalEngine.WebPartLayoutInfo.EXTERNAL_COLUMN_CSS"> <summary> External column name for WebPart Layout CSS </summary> </member> <member name="F:CMS.PortalEngine.WebPartLayoutInfo.TYPEINFO"> <summary> Type information. </summary> </member> <member name="F:CMS.PortalEngine.WebPartLayoutInfo.mWebPartLayoutFullName"> <summary> Web part layout full name. </summary> </member> <member name="F:CMS.PortalEngine.WebPartLayoutInfo.mCodeFileRegex"> <summary> Regular expressions for external layout code storage processing. </summary> </member> <member name="M:CMS.PortalEngine.WebPartLayoutInfo.DeleteObject"> <summary> Deletes the object using appropriate provider. </summary> </member> <member name="M:CMS.PortalEngine.WebPartLayoutInfo.SetObject"> <summary> Updates the object using appropriate provider. </summary> </member> <member name="M:CMS.PortalEngine.WebPartLayoutInfo.GetVirtualFileRelativePath(System.String,System.String)"> <summary> Returns virtual relative path for specific column </summary> <param name="externalColumnName">External column name</param> <param name="versionGuid">Version GUID. If not defined physical path is generated</param> </member> <member name="M:CMS.PortalEngine.WebPartLayoutInfo.RegisterExternalColumns"> <summary> Returns path to externally stored web part layout codes. </summary> </member> <member name="M:CMS.PortalEngine.WebPartLayoutInfo.ProcessLayoutSet(CMS.PortalEngine.WebPartLayoutInfo,System.Object,System.Boolean)"> <summary> Processes the layout code before it's stored in FS. </summary> <param name="info">WebPartLayout object</param> <param name="data">Data to process</param> <param name="readOnly">If true, transformation is called only in read-only mode - the codebehind should not be processed</param> </member> <member name="M:CMS.PortalEngine.WebPartLayoutInfo.ProcessLayoutGet(CMS.PortalEngine.WebPartLayoutInfo,System.Object)"> <summary> Processes the layout code before it's stored in FS. </summary> <param name="info">WebPartLayout object</param> <param name="data">Data to process</param> </member> <member name="M:CMS.PortalEngine.WebPartLayoutInfo.#ctor"> <summary> Constructor - Creates an empty WebPartLayoutInfo object. </summary> </member> <member name="M:CMS.PortalEngine.WebPartLayoutInfo.#ctor(System.Data.DataRow)"> <summary> Constructor - Creates a new WebPartLayoutInfo object from the given DataRow. </summary> </member> <member name="M:CMS.PortalEngine.WebPartLayoutInfo.GetThemePath"> <summary> Gets the theme path for the object </summary> </member> <member name="M:CMS.PortalEngine.WebPartLayoutInfo.GetPermissionName(CMS.DataEngine.PermissionsEnum)"> <summary> Converts PermissionEnum to permission codename which will be checked when CheckPermission() is called. </summary> <param name="permission">Permission to convert to string</param> </member> <member name="M:CMS.PortalEngine.WebPartLayoutInfo.CheckPermissionsInternal(CMS.DataEngine.PermissionsEnum,System.String,CMS.Base.IUserInfo,System.Boolean)"> <summary> Checks the permissions of the object. </summary> <param name="permission">Permission type</param> <param name="siteName">Name of the site</param> <param name="userInfo">UserInfo object</param> <param name="exceptionOnFailure">If true, PermissionCheckException is thrown whenever a permission check fails</param> </member> <member name="M:CMS.PortalEngine.WebPartLayoutInfo.InsertAsCloneInternal(CMS.DataEngine.CloneSettings,CMS.DataEngine.CloneResult,CMS.DataEngine.BaseInfo)"> <summary> Inserts cloned object to DB. </summary> <param name="settings">Cloning settings</param> <param name="result">Cloning result</param> <param name="originalObject">Original source BaseInfo (object being cloned)</param> </member> <member name="P:CMS.PortalEngine.WebPartLayoutInfo.InheritsRegex"> <summary> Regular expression for external layout code storage SET processing. </summary> </member> <member name="P:CMS.PortalEngine.WebPartLayoutInfo.InheritsRevertRegex"> <summary> Regular expression for external layout code storage GET processing. </summary> </member> <member name="P:CMS.PortalEngine.WebPartLayoutInfo.CodeFileRegex"> <summary> Regular expression for external layout code storage processing. </summary> </member> <member name="P:CMS.PortalEngine.WebPartLayoutInfo.CodeBehindRegex"> <summary> Regular expression for external layout code storage processing. </summary> </member> <member name="P:CMS.PortalEngine.WebPartLayoutInfo.WebPartLayoutVersionGUID"> <summary> Layout version GUID. </summary> </member> <member name="P:CMS.PortalEngine.WebPartLayoutInfo.WebPartLayoutDescription"> <summary> Layout description. </summary> </member> <member name="P:CMS.PortalEngine.WebPartLayoutInfo.WebPartLayoutDisplayName"> <summary> Layout display name. </summary> </member> <member name="P:CMS.PortalEngine.WebPartLayoutInfo.WebPartLayoutCodeName"> <summary> Layout code name. </summary> </member> <member name="P:CMS.PortalEngine.WebPartLayoutInfo.WebPartLayoutCSS"> <summary> Layout CSS. </summary> </member> <member name="P:CMS.PortalEngine.WebPartLayoutInfo.WebPartLayoutID"> <summary> Layout ID. </summary> </member> <member name="P:CMS.PortalEngine.WebPartLayoutInfo.WebPartLayoutCode"> <summary> Layout code. </summary> </member> <member name="P:CMS.PortalEngine.WebPartLayoutInfo.WebPartLayoutWebPartID"> <summary> Layout associated to webpart. </summary> </member> <member name="P:CMS.PortalEngine.WebPartLayoutInfo.WebPartLayoutIsDefault"> <summary> Indicates whether this layout is used as a default layout for the parent web part. </summary> </member> <member name="P:CMS.PortalEngine.WebPartLayoutInfo.WebPartLayoutGUID"> <summary> WebPart layout GUID. </summary> </member> <member name="P:CMS.PortalEngine.WebPartLayoutInfo.WebPartLayoutLastModified"> <summary> Object last modified. </summary> </member> <member name="P:CMS.PortalEngine.WebPartLayoutInfo.WebPartLayoutFullName"> <summary> Web part layout full name. </summary> </member> <member name="P:CMS.PortalEngine.WebPartLayoutInfo.ObjectFullName"> <summary> Object full name if defined </summary> </member> <member name="P:CMS.PortalEngine.WebPartLayoutInfo.UsesExternalStorage"> <summary> Indicates whether the theme path points at an external storage. </summary> </member> <member name="T:CMS.PortalEngine.WebPartLayoutInfoProvider"> <summary> Class providing WebPartLayoutInfo management. </summary> </member> <member name="F:CMS.PortalEngine.WebPartLayoutInfoProvider.mWebPartLayoutsDirectory"> <summary> Layouts directory readonly property. </summary> </member> <member name="M:CMS.PortalEngine.WebPartLayoutInfoProvider.#ctor"> <summary> Constructor. </summary> </member> <member name="M:CMS.PortalEngine.WebPartLayoutInfoProvider.GetWebPartLayoutInfoByGUID(System.Guid)"> <summary> Returns object with specified GUID. </summary> <param name="guid">Object GUID</param> </member> <member name="M:CMS.PortalEngine.WebPartLayoutInfoProvider.GetWebPartLayoutInfo(System.Int32)"> <summary> Returns the WebPartLayoutInfo structure for the specified webPartLayout. </summary> <param name="webPartLayoutId">WebPartLayout id</param> </member> <member name="M:CMS.PortalEngine.WebPartLayoutInfoProvider.GetWebPartLayoutInfo(System.String,System.String)"> <summary> Returns the WebPartLayoutInfo structure for the specified webPartLayout. </summary> <param name="webPartCodeName">Web part code name</param> <param name="webPartLayoutCodeName">WebPartLayout code name</param> </member> <member name="M:CMS.PortalEngine.WebPartLayoutInfoProvider.SetWebPartLayoutInfo(CMS.PortalEngine.WebPartLayoutInfo)"> <summary> Sets (updates or inserts) specified webPartLayout. </summary> <param name="infoObj">Web part layout to set</param> </member> <member name="M:CMS.PortalEngine.WebPartLayoutInfoProvider.DeleteWebPartLayoutInfo(CMS.PortalEngine.WebPartLayoutInfo)"> <summary> Deletes specified webPartLayout. </summary> <param name="webPartLayoutObj">WebPartLayout object</param> </member> <member name="M:CMS.PortalEngine.WebPartLayoutInfoProvider.DeleteWebPartLayoutInfo(System.Int32)"> <summary> Deletes specified webPartLayout. </summary> <param name="webPartLayoutId">WebPartLayout id</param> </member> <member name="M:CMS.PortalEngine.WebPartLayoutInfoProvider.DeleteWebPartLayouts(System.Int32)"> <summary> Deletes all web part layouts. </summary> <param name="webPartId">Web part ID</param> </member> <member name="M:CMS.PortalEngine.WebPartLayoutInfoProvider.GetWebPartLayouts"> <summary> Gets all web part layouts. </summary> </member> <member name="M:CMS.PortalEngine.WebPartLayoutInfoProvider.GetWebPartLayouts(System.Int32)"> <summary> Returns all layouts associated to the web part specified by ID. </summary> <param name="webPartId">Web part ID</param> </member> <member name="M:CMS.PortalEngine.WebPartLayoutInfoProvider.Clear(System.Boolean)"> <summary> Clear hashtables. </summary> <param name="logTasks">If true, web farm tasks are logged</param> </member> <member name="M:CMS.PortalEngine.WebPartLayoutInfoProvider.RemoveFromHash(System.String)"> <summary> Remove from hash table. </summary> <param name="dataText">Data text</param> </member> <member name="M:CMS.PortalEngine.WebPartLayoutInfoProvider.GetWebPartLayoutDirectives"> <summary> Layout directives are set before layout code. </summary> </member> <member name="M:CMS.PortalEngine.WebPartLayoutInfoProvider.GetVirtualObject(System.String)"> <summary> Returns web part layout info for specified path </summary> <param name="path">Path</param> </member> <member name="M:CMS.PortalEngine.WebPartLayoutInfoProvider.ResetDefaultLayout(System.Int32)"> <summary> Resets the default layout indicator for the given web part. </summary> <param name="webPartId">The web part id</param> </member> <member name="M:CMS.PortalEngine.WebPartLayoutInfoProvider.GetDefaultLayout(System.Int32)"> <summary> Gets the default layout for the given inherited web part. </summary> <param name="webPartId">The web part id</param> </member> <member name="M:CMS.PortalEngine.WebPartLayoutInfoProvider.ReplaceCodeFile(System.String)"> <summary> Replaces codebehind for codefile in layout definition </summary> <param name="input">Layout definition</param> </member> <member name="M:CMS.PortalEngine.WebPartLayoutInfoProvider.GetWebPartLayoutInfoInternal(System.Guid)"> <summary> Returns object with specified GUID. </summary> <param name="guid">Object GUID</param> </member> <member name="M:CMS.PortalEngine.WebPartLayoutInfoProvider.GetWebPartLayoutInfoInternal(System.Int32)"> <summary> Returns the WebPartLayoutInfo structure for the specified webPartLayout. </summary> <param name="webPartLayoutId">WebPartLayout id</param> </member> <member name="M:CMS.PortalEngine.WebPartLayoutInfoProvider.GetWebPartLayoutInfoInternal(System.String,System.String)"> <summary> Returns the WebPartLayoutInfo structure for the specified webPartLayout. </summary> <param name="webPartCodeName">Web part code name</param> <param name="webPartLayoutCodeName">WebPartLayout code name</param> </member> <member name="M:CMS.PortalEngine.WebPartLayoutInfoProvider.SetWebPartLayoutInfoInternal(CMS.PortalEngine.WebPartLayoutInfo)"> <summary> Sets (updates or inserts) specified webPartLayout. </summary> <param name="infoObj">Web part layout to set</param> </member> <member name="M:CMS.PortalEngine.WebPartLayoutInfoProvider.DeleteWebPartLayoutInfoInternal(CMS.PortalEngine.WebPartLayoutInfo)"> <summary> Deletes specified webPartLayout. </summary> <param name="webPartLayoutObj">WebPartLayout object</param> </member> <member name="M:CMS.PortalEngine.WebPartLayoutInfoProvider.GetWebPartLayoutsInternal"> <summary> Gets all web part layouts./// Gets all web part layouts. </summary> </member> <member name="M:CMS.PortalEngine.WebPartLayoutInfoProvider.ResetDefaultLayoutInternal(System.Int32)"> <summary> Resets the default layout indicator for all layouts of the given web part. </summary> <param name="webPartId">The web part id</param> </member> <member name="M:CMS.PortalEngine.WebPartLayoutInfoProvider.GetDefaultLayoutInternal(System.Int32)"> <summary> Gets the default layout for the given inherited web part. </summary> <param name="webPartId">The web part id</param> </member> <member name="M:CMS.PortalEngine.WebPartLayoutInfoProvider.GetFullNameDictionary"> <summary> Creates new dictionary for caching the objects by full name </summary> </member> <member name="M:CMS.PortalEngine.WebPartLayoutInfoProvider.GetFullNameWhereCondition(System.String)"> <summary> Gets the where condition that searches the object based on the given full name </summary> <param name="fullName">Object full name</param> </member> <member name="P:CMS.PortalEngine.WebPartLayoutInfoProvider.StoreWebPartLayoutsInExternalStorage"> <summary> Gets or sets the value that indicates whether web part layouts should be stored externally </summary> </member> <member name="P:CMS.PortalEngine.WebPartLayoutInfoProvider.WebPartLayoutsDirectory"> <summary> Readonly property LayoutsDirectory. </summary> </member> <member name="T:CMS.PortalEngine.WebPartZoneInstance"> <summary> Web part zone instance. Keeps configuration data for parent web part. </summary> </member> <member name="M:CMS.PortalEngine.WebPartZoneInstance.#ctor"> <summary> Constructor. </summary> </member> <member name="M:CMS.PortalEngine.WebPartZoneInstance.#ctor(System.Xml.XmlNode)"> <summary> Constructor. </summary> <param name="zoneNode">XML node with the zone data (containing the web parts information</param> </member> <member name="M:CMS.PortalEngine.WebPartZoneInstance.LoadVariants(System.Boolean,CMS.PortalEngine.VariantModeEnum)"> <summary> Loads all the MVT/Content personalization variants for this zone instance. </summary> <param name="forceLoad">Indicates if already loaded variants should be reloaded</param> <param name="variantMode">Specifies which variants should be loaded (MVT/ContentPersonalization/None - means both MVT+CP variants should try to load)</param> </member> <member name="M:CMS.PortalEngine.WebPartZoneInstance.GetWebPart(System.Guid)"> <summary> Returns the web part instance with specified GUID or null when not found. </summary> <param name="instanceGuid">Web part ID to get</param> </member> <member name="M:CMS.PortalEngine.WebPartZoneInstance.GetWebPart(System.String,System.Boolean)"> <summary> Returns the web part instance with specified ID or null when not found. </summary> <param name="webPartId">Web part ID to get</param> <param name="searchInVariants">Indicates whether to search in the zone variants as well.</param> </member> <member name="M:CMS.PortalEngine.WebPartZoneInstance.AddWebPart(System.Int32,System.Int32)"> <summary> Adds a web part instance of a specified type to the webparts. </summary> <param name="webPartId">Web part code name</param> <param name="position">The position of the web part in the target zone</param> </member> <member name="M:CMS.PortalEngine.WebPartZoneInstance.AddWidget(System.Int32)"> <summary> Adds a widget instance of a specified type. </summary> <param name="widgetId">Widget id</param> </member> <member name="M:CMS.PortalEngine.WebPartZoneInstance.AddWebPart(CMS.PortalEngine.WebPartInstance,System.Int32)"> <summary> Add the web part to the zone. If the web part is present in different zone, creates a copy of the web part. </summary> <param name="webPart">Web part to add</param> <param name="position">Position where to add the web part</param> <remarks>Returns a new instance of web part if the given web part is present within it's parent zone</remarks> </member> <member name="M:CMS.PortalEngine.WebPartZoneInstance.GetUniqueWebPartId(System.String,CMS.PortalEngine.PageTemplateInstance,System.Int32)"> <summary> Returns unique web part ID within the given Page template. </summary> <param name="baseId">Base web part id (required)</param> <param name="templateInstance">Page template instance</param> <param name="counterOffset">The counter number which will be used as a starter counter for checking the unique id. Example: counterOffset=2, returns ids starting with number two ('wp_2', 'wp_3', 'wp_4'...)</param> </member> <member name="M:CMS.PortalEngine.WebPartZoneInstance.RemoveAllWebParts"> <summary> Removes all web parts from the schema. </summary> </member> <member name="M:CMS.PortalEngine.WebPartZoneInstance.RemoveWebPart(CMS.PortalEngine.WebPartInstance)"> <summary> Removes the web part instance from the schema. </summary> <param name="webPart">Web part</param> </member> <member name="M:CMS.PortalEngine.WebPartZoneInstance.RemoveWebPart(System.String)"> <summary> Removes the web part instance from the web part list. </summary> </member> <member name="M:CMS.PortalEngine.WebPartZoneInstance.GetXmlNode(System.Xml.XmlDocument)"> <summary> Returns the Xml node representing the zone configuration. </summary> <param name="doc">Parent XML document</param> </member> <member name="M:CMS.PortalEngine.WebPartZoneInstance.MoveWebPartUp(System.String,System.Boolean)"> <summary> Moves the specified web part up within the zone instance. </summary> <param name="webPartId">Web part ID to move up</param> <param name="top">If true, the web part is moved to the top</param> </member> <member name="M:CMS.PortalEngine.WebPartZoneInstance.MoveWebPartDown(System.String,System.Boolean)"> <summary> Moves the specified web part down within the zone instance. </summary> <param name="webPartId">Web part ID to move up</param> <param name="bottom">If true, the web part is moved to the bottom</param> </member> <member name="M:CMS.PortalEngine.WebPartZoneInstance.EnsureWebPartInstanceIdentificators(CMS.PortalEngine.WebPartInstance,System.String)"> <summary> Ensures web part ControlID and instance GUID for current zone </summary> <param name="w">Web part instance</param> <param name="webPartId">Web part ID</param> </member> <member name="M:CMS.PortalEngine.WebPartZoneInstance.CloneWebPart(System.String)"> <summary> Clones the web part. </summary> <param name="webPartId">Web part ID to clone</param> </member> <member name="M:CMS.PortalEngine.WebPartZoneInstance.Clone(System.Boolean,System.Boolean)"> <summary> Returns the cloned zone instance object. </summary> <param name="cloneWebParts">If true, the web parts are cloned within the zone</param> <param name="copyMacroTable">Indicates whether macro values should be cloned</param> </member> <member name="M:CMS.PortalEngine.WebPartZoneInstance.LoadProperties(CMS.PortalEngine.WebPartZoneInstance)"> <summary> Loads the zone properties from given zone. </summary> <param name="zone">Zone to load</param> </member> <member name="M:CMS.PortalEngine.WebPartZoneInstance.GetValue(System.String)"> <summary> Returns the value of the given webpart property property. </summary> <param name="propertyName">Property name</param> </member> <member name="M:CMS.PortalEngine.WebPartZoneInstance.SetValue(System.String,System.Object)"> <summary> Sets the property value of the control. </summary> <param name="propertyName">Property name to set</param> <param name="value">New property value</param> </member> <member name="M:CMS.PortalEngine.WebPartZoneInstance.ClearValues(System.String[])"> <summary> Clears the given properties </summary> <param name="propertyNames">Property names to clear</param> </member> <member name="P:CMS.PortalEngine.WebPartZoneInstance.XMLVersion"> <summary> Gets or sets the zone instance XML version </summary> </member> <member name="P:CMS.PortalEngine.WebPartZoneInstance.MacroTable"> <summary> Hashtable with IsMacro flags. </summary> </member> <member name="P:CMS.PortalEngine.WebPartZoneInstance.WebParts"> <summary> Web parts collection within the zone. </summary> </member> <member name="P:CMS.PortalEngine.WebPartZoneInstance.LayoutZone"> <summary> If true, the zone is generated by layout. </summary> </member> <member name="P:CMS.PortalEngine.WebPartZoneInstance.ZoneID"> <summary> Web part zone ID. </summary> </member> <member name="P:CMS.PortalEngine.WebPartZoneInstance.ParentTemplateInstance"> <summary> Parent PageTemplate instance for the zone. </summary> </member> <member name="P:CMS.PortalEngine.WebPartZoneInstance.Properties"> <summary> Web part properties table. </summary> </member> <member name="P:CMS.PortalEngine.WebPartZoneInstance.InstanceGUID"> <summary> Instance GUID to identify the web part. </summary> </member> <member name="P:CMS.PortalEngine.WebPartZoneInstance.WidgetZoneType"> <summary> Widget zone type. </summary> </member> <member name="P:CMS.PortalEngine.WebPartZoneInstance.ZoneInstanceVariants"> <summary> Gets the zone instance variant list. </summary> </member> <member name="P:CMS.PortalEngine.WebPartZoneInstance.IsVariant"> <summary> Indicates if webpart instance is a variant of the original web part </summary> </member> <member name="P:CMS.PortalEngine.WebPartZoneInstance.VariantID"> <summary> Gets or sets the variant id. </summary> </member> <member name="P:CMS.PortalEngine.WebPartZoneInstance.HasVariants"> <summary> Indicates whether the web part zone has any variants. </summary> </member> <member name="P:CMS.PortalEngine.WebPartZoneInstance.WebPartsContainVariants"> <summary> Indicates whether any of the zone web parts contains variants. </summary> </member> <member name="P:CMS.PortalEngine.WebPartZoneInstance.VariantMode"> <summary> Gets the variant mode which is used for the variants of this web part instance. </summary> </member> <member name="T:CMS.PortalEngine.WidgetInfo"> <summary> Widget info class. </summary> </member> <member name="F:CMS.PortalEngine.WidgetInfo.OBJECT_TYPE"> <summary> Object type </summary> </member> <member name="F:CMS.PortalEngine.WidgetInfo.GROUPPAGESLIST"> <summary> Community group page list </summary> </member> <member name="F:CMS.PortalEngine.WidgetInfo.TYPEINFO"> <summary> Type information. </summary> </member> <member name="M:CMS.PortalEngine.WidgetInfo.DeleteObject"> <summary> Deletes the object using appropriate provider. </summary> </member> <member name="M:CMS.PortalEngine.WidgetInfo.SetObject"> <summary> Updates the object using appropriate provider. </summary> </member> <member name="M:CMS.PortalEngine.WidgetInfo.GetFields(System.String@)"> <summary> Returns widget properties which are visible for users. </summary> <returns>Field names separated by semicolon</returns> </member> <member name="M:CMS.PortalEngine.WidgetInfo.InsertAsCloneInternal(CMS.DataEngine.CloneSettings,CMS.DataEngine.CloneResult,CMS.DataEngine.BaseInfo)"> <summary> Inserts cloned object to DB. </summary> <param name="settings">Cloning settings</param> <param name="result">Cloning result</param> <param name="originalObject">Original source BaseInfo (object being cloned)</param> </member> <member name="M:CMS.PortalEngine.WidgetInfo.#ctor"> <summary> Constructor - Creates an empty WidgetInfo object. </summary> </member> <member name="M:CMS.PortalEngine.WidgetInfo.#ctor(System.Data.DataRow)"> <summary> Constructor - Creates a new WidgetInfo object from the given DataRow. </summary> </member> <member name="M:CMS.PortalEngine.WidgetInfo.#ctor(CMS.PortalEngine.WidgetInfo,System.Boolean)"> <summary> Constructor - Creates a new WidgetInfo object from the given DataClass. </summary> <param name="wi">WidgetInfo</param> <param name="keepSourceData">If true, source data are kept in the object</param> </member> <member name="M:CMS.PortalEngine.WidgetInfo.LoadDefaultData"> <summary> Loads the default object data </summary> </member> <member name="M:CMS.PortalEngine.WidgetInfo.GetUsageObjectTypes"> <summary> Gets the list of object types that may use the widget </summary> </member> <member name="M:CMS.PortalEngine.WidgetInfo.GetUsages"> <summary> Gets the objects using the widget as a query with result columns ObjectType, ObjectID, Source, ItemID and ItemObjectType. </summary> </member> <member name="M:CMS.PortalEngine.WidgetInfo.GetWidgetSearchCondition(System.String,System.String,System.String)"> <summary> Creates where condition to find current widget in form definition (usable for page template, MVT variants and CP variants) </summary> <param name="columnName">Widget definition column name</param> <param name="name">Widget name</param> <param name="webPartXmlLocation">Location where web part nodes can be found in XML</param> </member> <member name="M:CMS.PortalEngine.WidgetInfo.AddTypeToUsageQuery(CMS.DataEngine.MultiObjectQuery,System.String,System.String,CMS.DataEngine.IWhereCondition,System.String,System.String,System.String)"> <summary> Adds type to query to get all usages of current widget </summary> <param name="query">Multi object query</param> <param name="objectType">Object type to add to search in</param> <param name="idColumn">ID column name of the object</param> <param name="condition">Condition how to find the current widget</param> <param name="source">Text information about the source</param> <param name="itemId">ID of the additional object</param> <param name="itemObjectType">Object type of the additional object</param> </member> <member name="P:CMS.PortalEngine.WidgetInfo.WidgetID"> <summary> Widget ID. </summary> </member> <member name="P:CMS.PortalEngine.WidgetInfo.WidgetName"> <summary> Widget name. </summary> </member> <member name="P:CMS.PortalEngine.WidgetInfo.WidgetDisplayName"> <summary> Display name. </summary> </member> <member name="P:CMS.PortalEngine.WidgetInfo.WidgetGUID"> <summary> Widget GUID. </summary> </member> <member name="P:CMS.PortalEngine.WidgetInfo.WidgetLastModified"> <summary> Time of last modification. </summary> </member> <member name="P:CMS.PortalEngine.WidgetInfo.WidgetWebPartID"> <summary> Widget web part ID. </summary> </member> <member name="P:CMS.PortalEngine.WidgetInfo.WidgetCategoryID"> <summary> Widget category ID. </summary> </member> <member name="P:CMS.PortalEngine.WidgetInfo.WidgetDefaultValues"> <summary> Widget default values. </summary> </member> <member name="P:CMS.PortalEngine.WidgetInfo.WidgetDocumentation"> <summary> Widget documentation. </summary> </member> <member name="P:CMS.PortalEngine.WidgetInfo.WidgetSecurity"> <summary> Widget security bit array. </summary> </member> <member name="P:CMS.PortalEngine.WidgetInfo.AllowedFor"> <summary> Indicates whether the access to widget is allowed. </summary> </member> <member name="P:CMS.PortalEngine.WidgetInfo.WidgetDescription"> <summary> Widget description. </summary> </member> <member name="P:CMS.PortalEngine.WidgetInfo.WidgetLayoutID"> <summary> Widget layout ID. </summary> </member> <member name="P:CMS.PortalEngine.WidgetInfo.WidgetProperties"> <summary> Widget properties. </summary> </member> <member name="P:CMS.PortalEngine.WidgetInfo.WidgetForGroup"> <summary> Indicates whether the widget is for group members. </summary> </member> <member name="P:CMS.PortalEngine.WidgetInfo.WidgetForUser"> <summary> Indicates whether the widget is for user. </summary> </member> <member name="P:CMS.PortalEngine.WidgetInfo.WidgetForEditor"> <summary> Indicates whether the widget is for editor. </summary> </member> <member name="P:CMS.PortalEngine.WidgetInfo.WidgetForInline"> <summary> Indicates whether the widget can be used as inline. </summary> </member> <member name="P:CMS.PortalEngine.WidgetInfo.WidgetForDashboard"> <summary> Indicates whether the widget can be used in dashboard. </summary> </member> <member name="P:CMS.PortalEngine.WidgetInfo.WidgetIsEnabled"> <summary> Enables or disables widget. </summary> </member> <member name="P:CMS.PortalEngine.WidgetInfo.WidgetPublicFileds"> <summary> Gets or sets the widget public fields. </summary> </member> <member name="P:CMS.PortalEngine.WidgetInfo.WidgetFields"> <summary> Gets the widget field list. </summary> </member> <member name="P:CMS.PortalEngine.WidgetInfo.WidgetSkipInsertProperties"> <summary> Indicates whether the widget properties dialog should be displayed when inserting a widget to the page. </summary> </member> <member name="P:CMS.PortalEngine.WidgetInfo.WidgetThumbnailGUID"> <summary> Widget thumbnail metafile GUID. </summary> </member> <member name="P:CMS.PortalEngine.WidgetInfo.WidgetIconClass"> <summary> Widget icon class defining the widget thumbnail. </summary> </member> <member name="T:CMS.PortalEngine.WidgetInfoProvider"> <summary> Class providing WidgetInfo management. </summary> </member> <member name="M:CMS.PortalEngine.WidgetInfoProvider.Clear(System.Boolean)"> <summary> Clear hashtables. </summary> <param name="logTasks">If true, web farm tasks are logged</param> </member> <member name="M:CMS.PortalEngine.WidgetInfoProvider.GetWidgetInfo(System.Int32)"> <summary> Returns the WidgetInfo structure for the specified widget id. </summary> <param name="widgetId">Widget id</param> </member> <member name="M:CMS.PortalEngine.WidgetInfoProvider.GetWidgetInfo(System.String)"> <summary> Returns the WidgetInfo structure for the specified widget name. </summary> <param name="widgetName">Widget name (code name)</param> </member> <member name="M:CMS.PortalEngine.WidgetInfoProvider.GetWidgetInfo(System.Guid)"> <summary> Returns the WidgetInfo structure for the specified widget GUID. </summary> <param name="widgetGuid">Widget Guid</param> <returns>Widget info object</returns> </member> <member name="M:CMS.PortalEngine.WidgetInfoProvider.GetWidgets"> <summary> Returns all widgets. </summary> </member> <member name="M:CMS.PortalEngine.WidgetInfoProvider.SetWidgetInfo(CMS.PortalEngine.WidgetInfo)"> <summary> Sets (updates or inserts) specified widget. </summary> <param name="widget">Widget to set</param> </member> <member name="M:CMS.PortalEngine.WidgetInfoProvider.DeleteWidgetInfo(CMS.PortalEngine.WidgetInfo)"> <summary> Deletes specified widget with dependencies. </summary> <param name="infoObj">Widget object</param> </member> <member name="M:CMS.PortalEngine.WidgetInfoProvider.DeleteWidgetInfo(System.Int32)"> <summary> Deletes specified widget with dependencies. </summary> <param name="widgetId">Widget ID</param> </member> <member name="M:CMS.PortalEngine.WidgetInfoProvider.GetWidgetsInternal"> <summary> Returns all widgets. </summary> </member> <member name="M:CMS.PortalEngine.WidgetInfoProvider.GetWidgetInfoInternal(System.Int32)"> <summary> Returns the WidgetInfo structure for the specified widget id. </summary> <param name="widgetId">Widget id</param> </member> <member name="M:CMS.PortalEngine.WidgetInfoProvider.GetWidgetInfoInternal(System.String)"> <summary> Returns the WidgetInfo structure for the specified widget name. </summary> <param name="widgetName">Widget name(code name)</param> </member> <member name="M:CMS.PortalEngine.WidgetInfoProvider.GetWidgetInfoByGuidInternal(System.Guid)"> <summary> Returns the WidgetInfo structure for the specified guid. </summary> <param name="guid">Widget Guid</param> </member> <member name="M:CMS.PortalEngine.WidgetInfoProvider.SetWidgetInfoInternal(CMS.PortalEngine.WidgetInfo)"> <summary> Sets (updates or inserts) specified widget. </summary> <param name="widget">Widget to set</param> </member> <member name="M:CMS.PortalEngine.WidgetInfoProvider.DeleteWidgetInfoInternal(CMS.PortalEngine.WidgetInfo)"> <summary> Deletes specified widget with dependencies. </summary> <param name="widget">Widget object</param> </member> <member name="M:CMS.PortalEngine.WidgetInfoProvider.#ctor"> <summary> Constructor. </summary> </member> <member name="T:CMS.PortalEngine.WidgetZoneTypeEnum"> <summary> Widget zone type enumeration. </summary> </member> <member name="F:CMS.PortalEngine.WidgetZoneTypeEnum.All"> <summary> All zone types (special value to get the zone XML). </summary> </member> <member name="F:CMS.PortalEngine.WidgetZoneTypeEnum.None"> <summary> Standard zone. </summary> </member> <member name="F:CMS.PortalEngine.WidgetZoneTypeEnum.User"> <summary> User personalization. </summary> </member> <member name="F:CMS.PortalEngine.WidgetZoneTypeEnum.Editor"> <summary> Editor personalization. </summary> </member> <member name="F:CMS.PortalEngine.WidgetZoneTypeEnum.Group"> <summary> Group personalization. </summary> </member> <member name="F:CMS.PortalEngine.WidgetZoneTypeEnum.Dashboard"> <summary> Dashboard. </summary> </member> <member name="T:CMS.PortalEngine.WidgetInfoMethods"> <summary> Macro methods for class WidgetInfo </summary> </member> <member name="M:CMS.PortalEngine.WidgetInfoMethods.GetUsageObjectTypes(CMS.MacroEngine.EvaluationContext,System.Object[])"> <summary> Macro method for method GetUsageObjectTypes </summary> </member> <member name="M:CMS.PortalEngine.WidgetInfoMethods.GetUsages(CMS.MacroEngine.EvaluationContext,System.Object[])"> <summary> Macro method for method GetUsages </summary> </member> </members> </doc> |