CMS.BannerManagement.xml
|
<?xml version="1.0"?>
<doc> <assembly> <name>CMS.BannerManagement</name> </assembly> <members> <member name="T:CMS.BannerManagement.BannerImageAttributes"> <summary> Banner image attributes. </summary> </member> <member name="P:CMS.BannerManagement.BannerImageAttributes.Src"> <summary> Image source path </summary> </member> <member name="P:CMS.BannerManagement.BannerImageAttributes.Title"> <summary> Image title </summary> </member> <member name="P:CMS.BannerManagement.BannerImageAttributes.Alt"> <summary> Image alternate text </summary> </member> <member name="P:CMS.BannerManagement.BannerImageAttributes.Class"> <summary> Image CSS class </summary> </member> <member name="P:CMS.BannerManagement.BannerImageAttributes.Style"> <summary> Image CSS style </summary> </member> <member name="T:CMS.BannerManagement.BannerInfo"> <summary> BannerInfo data container class. </summary> </member> <member name="F:CMS.BannerManagement.BannerInfo.OBJECT_TYPE"> <summary> Object type </summary> </member> <member name="F:CMS.BannerManagement.BannerInfo.TYPEINFO"> <summary> Type information. </summary> </member> <member name="P:CMS.BannerManagement.BannerInfo.BannerName"> <summary> Code name of the banner. </summary> </member> <member name="P:CMS.BannerManagement.BannerInfo.BannerEnabled"> <summary> True if banner is enabled. </summary> </member> <member name="P:CMS.BannerManagement.BannerInfo.BannerGuid"> <summary> Banner guid. </summary> </member> <member name="P:CMS.BannerManagement.BannerInfo.BannerBlank"> <summary> If true link will lead to new window (target _blank). </summary> </member> <member name="P:CMS.BannerManagement.BannerInfo.BannerID"> <summary> ID of the banner. </summary> </member> <member name="P:CMS.BannerManagement.BannerInfo.BannerTo"> <summary> Banner will be displayed to this time. </summary> </member> <member name="P:CMS.BannerManagement.BannerInfo.BannerFrom"> <summary> Banner will be displayed from this time. </summary> </member> <member name="P:CMS.BannerManagement.BannerInfo.BannerHitsLeft"> <summary> Hits left. </summary> </member> <member name="P:CMS.BannerManagement.BannerInfo.BannerClicksLeft"> <summary> Clicks left. </summary> </member> <member name="P:CMS.BannerManagement.BannerInfo.BannerWeight"> <summary> Weight of the banner. Banners with higher weight will be displayed more often. </summary> </member> <member name="P:CMS.BannerManagement.BannerInfo.BannerContent"> <summary> Banner HTML text. </summary> </member> <member name="P:CMS.BannerManagement.BannerInfo.BannerCategoryID"> <summary> Category of the banner. </summary> </member> <member name="P:CMS.BannerManagement.BannerInfo.BannerDisplayName"> <summary> Display name of the banner. </summary> </member> <member name="P:CMS.BannerManagement.BannerInfo.BannerURL"> <summary> URL to be redirected to after clicking the banner. </summary> </member> <member name="P:CMS.BannerManagement.BannerInfo.BannerType"> <summary> Banner type. </summary> </member> <member name="P:CMS.BannerManagement.BannerInfo.BannerLastModified"> <summary> Last modification of this banner. </summary> </member> <member name="P:CMS.BannerManagement.BannerInfo.BannerSiteID"> <summary> Banner site ID. </summary> </member> <member name="M:CMS.BannerManagement.BannerInfo.DeleteObject"> <summary> Deletes the object using appropriate provider. </summary> </member> <member name="M:CMS.BannerManagement.BannerInfo.SetObject"> <summary> Updates the object using appropriate provider. </summary> </member> <member name="M:CMS.BannerManagement.BannerInfo.#ctor"> <summary> Constructor - Creates an empty BannerInfo object. </summary> </member> <member name="M:CMS.BannerManagement.BannerInfo.#ctor(System.Data.DataRow)"> <summary> Constructor - Creates a new BannerInfo object from the given DataRow. </summary> <param name="dr">DataRow with the object data.</param> </member> <member name="T:CMS.BannerManagement.BannerInfoProvider"> <summary> Class providing BannerInfo management. </summary> </member> <member name="M:CMS.BannerManagement.BannerInfoProvider.GetBanners(System.String,System.String,System.Int32,System.String)"> <summary> Returns object query of all banners 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.BannerManagement.BannerInfoProvider.GetBannerInfo(System.Int32)"> <summary> Returns banner with specified ID. </summary> <param name="bannerId">Banner ID.</param> </member> <member name="M:CMS.BannerManagement.BannerInfoProvider.SetBannerInfo(CMS.BannerManagement.BannerInfo)"> <summary> Sets (updates or inserts) specified banner. </summary> <param name="bannerObj">Banner to be set.</param> </member> <member name="M:CMS.BannerManagement.BannerInfoProvider.DeleteBannerInfo(CMS.BannerManagement.BannerInfo)"> <summary> Deletes specified banner. </summary> <param name="bannerObj">Banner to be deleted.</param> </member> <member name="M:CMS.BannerManagement.BannerInfoProvider.DeleteBannerInfo(System.Int32)"> <summary> Deletes banner with specified ID. </summary> <param name="bannerId">Banner ID.</param> </member> <member name="M:CMS.BannerManagement.BannerInfoProvider.GetBanners"> <summary> Returns the query for all banners. </summary> </member> <member name="M:CMS.BannerManagement.BannerInfoProvider.DecrementClicksLeft(System.Int32)"> <summary> Decrement clicks left of banner with <paramref name="bannerId"/>. Does nothing if banner has clicks left set to NULL. </summary> <param name="bannerId">ID of a banner</param> </member> <member name="M:CMS.BannerManagement.BannerInfoProvider.GetRandomValidBanner(System.Int32,System.Boolean)"> <summary> Returns the BannerInfo structure for the random banner. Banner has to be: - enabled - valid now (ValidFrom and ValidTo) or ValidFrom and ValidTo can be null - and has more than 0 hits and clicks left (or null - unlimited) </summary> <param name="categoryId">Category ID.</param> <param name="decrementHitsLeft">If true, hits left (after reaching 0, this banner won't be returned) of the returned banner will be decremented</param> </member> <member name="M:CMS.BannerManagement.BannerInfoProvider.DecrementClicksLeftInternal(System.Int32)"> <summary> Decrement clicks left of banner with <paramref name="bannerId"/>. Does nothing if banner has clicks left set to NULL. </summary> <param name="bannerId">ID of a banner</param> </member> <member name="M:CMS.BannerManagement.BannerInfoProvider.GetRandomValidBannerInternal(System.Int32,System.Boolean)"> <summary> Returns the BannerInfo structure for the random banner. Banner has to be: - enabled - valid now (ValidFrom and ValidTo) or ValidFrom and ValidTo can be null - and has more than 0 hits and clicks left (or null - unlimited) </summary> <param name="categoryId">Category ID.</param> <param name="decrementHitsLeft">If true, hits left (after reaching 0, this banner won't be returned) of the returned banner will be decremented</param> </member> <member name="T:CMS.BannerManagement.BannerManagementHelper"> <summary> Helper class for Banner management. </summary> </member> <member name="M:CMS.BannerManagement.BannerManagementHelper.SerializeBannerImageAttributes(CMS.BannerManagement.BannerImageAttributes)"> <summary> Serializes data from BannerImageAttributes and returns XmlDocument. <param name="bannerImg">Banner image attributes</param> </summary> </member> <member name="M:CMS.BannerManagement.BannerManagementHelper.SerializeBannerImageAttributesToString(CMS.BannerManagement.BannerImageAttributes)"> <summary> Serializes data from BannerImageAttributes and returns XML as a string. </summary> <param name="bannerImg">Banner image attributes</param> <returns>Banner image attributes serialized in XML.</returns> </member> <member name="M:CMS.BannerManagement.BannerManagementHelper.DeserializeBannerImageAttributes(System.String)"> <summary> Deserializes the passed XML in string and returns BannerImageAttributes. </summary> <param name="xmlString">XML</param> </member> <member name="M:CMS.BannerManagement.BannerManagementHelper.DeserializeBannerImageAttributes(System.Xml.XmlDocument)"> <summary> Deserializes the passed XmlDocument and returns BannerImageAttributes. </summary> <param name="xmlDocument">XML document with banner image</param> </member> <member name="T:CMS.BannerManagement.BannerTypeEnum"> <summary> Banner type enumeration </summary> </member> <member name="F:CMS.BannerManagement.BannerTypeEnum.Plain"> <summary> Plain type </summary> </member> <member name="F:CMS.BannerManagement.BannerTypeEnum.HTML"> <summary> HTML type </summary> </member> <member name="F:CMS.BannerManagement.BannerTypeEnum.Image"> <summary> Image type </summary> </member> <member name="T:CMS.BannerManagement.BannerCategoryInfo"> <summary> BannerCategoryInfo data container class. </summary> </member> <member name="F:CMS.BannerManagement.BannerCategoryInfo.OBJECT_TYPE"> <summary> Object type </summary> </member> <member name="F:CMS.BannerManagement.BannerCategoryInfo.TYPEINFO"> <summary> Type information. </summary> </member> <member name="P:CMS.BannerManagement.BannerCategoryInfo.BannerCategoryDisplayName"> <summary> Display name of the banner category. </summary> </member> <member name="P:CMS.BannerManagement.BannerCategoryInfo.BannerCategoryName"> <summary> Code name of the banner category. </summary> </member> <member name="P:CMS.BannerManagement.BannerCategoryInfo.BannerCategoryEnabled"> <summary> State of banner category. True if enabled; false if disabled. </summary> </member> <member name="P:CMS.BannerManagement.BannerCategoryInfo.BannerCategoryID"> <summary> ID of the banner category. </summary> </member> <member name="P:CMS.BannerManagement.BannerCategoryInfo.BannerCategoryGuid"> <summary> Banner category GUID. </summary> </member> <member name="P:CMS.BannerManagement.BannerCategoryInfo.BannerCategoryLastModified"> <summary> Time of last modification of this banner category. </summary> </member> <member name="P:CMS.BannerManagement.BannerCategoryInfo.BannerCategorySiteID"> <summary> ID of the site where banner category is located (or null if this is a global category). </summary> </member> <member name="M:CMS.BannerManagement.BannerCategoryInfo.DeleteObject"> <summary> Deletes the object using appropriate provider. </summary> </member> <member name="M:CMS.BannerManagement.BannerCategoryInfo.SetObject"> <summary> Updates the object using appropriate provider. </summary> </member> <member name="M:CMS.BannerManagement.BannerCategoryInfo.#ctor"> <summary> Constructor - Creates an empty BannerCategoryInfo object. </summary> </member> <member name="M:CMS.BannerManagement.BannerCategoryInfo.#ctor(System.Data.DataRow)"> <summary> Constructor - Creates a new BannerCategoryInfo object from the given DataRow. </summary> <param name="dr">DataRow with the object data.</param> </member> <member name="M:CMS.BannerManagement.BannerCategoryInfo.InsertAsClonePostprocessing(CMS.DataEngine.CloneSettings,CMS.DataEngine.CloneResult,CMS.DataEngine.BaseInfo)"> <summary> Inserts banners from the cloned category to the new one. Objects of type Category cannot have a child-parent relationship with its children, co cloning will not clone banners. </summary> <param name="settings">Cloning settings</param> <param name="result">Result of the cloning - messages in this object will be altered by processing this method</param> <param name="originalObject">Original source BaseInfo (object being cloned)</param> </member> <member name="T:CMS.BannerManagement.BannerCategoryInfoProvider"> <summary> Class providing BannerCategoryInfo management. </summary> </member> <member name="M:CMS.BannerManagement.BannerCategoryInfoProvider.#ctor"> <summary> Constructor </summary> </member> <member name="M:CMS.BannerManagement.BannerCategoryInfoProvider.GetBannerCategories(System.String,System.String,System.Int32,System.String)"> <summary> Returns object query of all banner categories 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.BannerManagement.BannerCategoryInfoProvider.GetBannerCategoryInfo(System.Int32)"> <summary> Returns banner category with specified ID. </summary> <param name="categoryId">Banner category ID.</param> </member> <member name="M:CMS.BannerManagement.BannerCategoryInfoProvider.GetBannerCategoryInfo(System.String)"> <summary> Returns banner category with specified code name. </summary> <param name="categoryCodeName">Banner category code name.</param> </member> <member name="M:CMS.BannerManagement.BannerCategoryInfoProvider.SetBannerCategoryInfo(CMS.BannerManagement.BannerCategoryInfo)"> <summary> Sets (updates or inserts) specified banner category. </summary> <param name="categoryObj">Banner category to be set.</param> </member> <member name="M:CMS.BannerManagement.BannerCategoryInfoProvider.DeleteBannerCategoryInfo(CMS.BannerManagement.BannerCategoryInfo)"> <summary> Deletes specified banner category. </summary> <param name="categoryObj">Banner category to be deleted.</param> </member> <member name="M:CMS.BannerManagement.BannerCategoryInfoProvider.DeleteBannerCategoryInfo(System.Int32)"> <summary> Deletes banner category with specified ID. </summary> <param name="categoryId">Banner category ID.</param> </member> <member name="M:CMS.BannerManagement.BannerCategoryInfoProvider.GetBannerCategories"> <summary> Returns the query for all banner categories. </summary> </member> <member name="M:CMS.BannerManagement.BannerCategoryInfoProvider.GetBannerCategories(System.Int32)"> <summary> Returns object query for all banner categories for specified site ordered by category display name. </summary> <param name="siteId">Site ID.</param> </member> <member name="M:CMS.BannerManagement.BannerCategoryInfoProvider.GetBannerCategoryInfoFromSiteOrGlobal(System.String,System.Int32)"> <summary> Gets banner category info with the specified name. First, banner categories assigned to the site specified by <paramref name="siteId"/> are searched and then global banner categories. If there is no banner category with this name on specified site or global, null is returned. </summary> <param name="bannerCategoryCodeName">Code name.</param> <param name="siteId">Site to be searched.</param> </member> <member name="M:CMS.BannerManagement.BannerCategoryInfoProvider.GetBannerCategoryInfoFromSiteOrGlobalInternal(System.String,System.Int32)"> <summary> Gets banner category info with the specified name. First, banner categories assigned to the site specified by <paramref name="siteId"/> are searched and then global banner categories. If there is no banner category with this name on specified site or global, null is returned. </summary> <param name="bannerCategoryCodeName">Code name.</param> <param name="siteId">Site to be searched.</param> </member> <member name="T:CMS.BannerManagement.BannerRedirect"> <summary> Redirects user to the banner's address and logs banner click for banner with specified ID. </summary> </member> <member name="P:CMS.BannerManagement.BannerRedirect.IsReusable"> <summary> This handler can be reused. </summary> </member> <member name="M:CMS.BannerManagement.BannerRedirect.ProcessRequest(System.Web.HttpContext)"> <summary> Redirects user to the address of the banner specified by the query parameter "bannerID" and logs banner click. </summary> </member> <member name="T:CMS.BannerManagement.BannerHandlers"> <summary> Banner management event handlers. </summary> </member> <member name="M:CMS.BannerManagement.BannerHandlers.Init"> <summary> Initializes the events handlers. </summary> </member> <member name="M:CMS.BannerManagement.BannerHandlers.GenerateStatistics_After(System.Object,CMS.WebAnalytics.GenerateStatisticsEventArgs)"> <summary> Generates statistics "Banner hits" and "Banner impressions". </summary> </member> <member name="T:CMS.BannerManagement.BannerModuleMetadata"> <summary> Represents the Banner module metadata. </summary> </member> <member name="M:CMS.BannerManagement.BannerModuleMetadata.#ctor"> <summary> Default constructor </summary> </member> <member name="T:CMS.BannerManagement.BannerModule"> <summary> Represents the Banner module. </summary> </member> <member name="M:CMS.BannerManagement.BannerModule.#ctor"> <summary> Default constructor </summary> </member> </members> </doc> |