RibbonBarAddIn Class |
Namespace: Dynamicweb.Controls.Extensibility
The RibbonBarAddIn type exposes the following members.
Name | Description | |
---|---|---|
RibbonBarAddIn |
Initializes a new instance of an object.
|
Name | Description | |
---|---|---|
CanInstantiate |
Gets value indicating whether add-in can be instantiated within the current container.
| |
Page |
Gets an instance of Page object that contains an add-in.
| |
Ribbon |
Gets an instance of RibbonBar object that contains an add-in.
| |
Trace |
Gets a reference to a trace object that can be used to write trace information to the output.
| |
Windows |
Gets a list of all pop-up windows associated with this add-in.
|
Name | Description | |
---|---|---|
AddWindow |
Adds new pop-up window.
| |
ContainsWindow |
Determines whether specified add-in contains specified pop-up window.
| |
CreateAddInInstance |
Creates an instance of the specified RibbonBar add-in.
| |
CreateDefaultContainer |
Creates (or retrieves an existing instance) of the default add-ins group within the current RibbonBar control.
| |
GetAddInTypesByLocation |
Retrieves the list of add-in types for a given location.
| |
GetAddInTypesByPage |
Retrieves the list of add-in types for the given instance of Page object.
| |
GetAllAddInTypes |
Retrieves the list of all add-in types that are currently loaded into the app domain.
| |
Initialize |
Performs "Initialize" stage.
| |
Load |
Performs "Load" stage.
| |
RemoveWindow(String) |
Removes specified pop-up window.
| |
RemoveWindow(Dialog) |
Removes specified pop-up window.
| |
Render |
Sends add-in's output to specified HtmlTextWriter object.
| |
RenderWindows |
Sends add-in windows' output to specified HtmlTextWriter object.
|
using Dynamicweb.Controls.Extensibility; using Dynamicweb.Core.UI.Icons; using Dynamicweb.Extensibility.AddIns; using System; using System.Collections.Generic; using System.Linq; using System.Text; using System.Threading.Tasks; namespace Dynamicweb.Controls.Examples { [AddInTarget("/Admin/Module/eCom_Catalog/dw7/PIM/PimProductList.aspx")] [AddInTarget("/Admin/Module/eCom_Catalog/dw7/PIM/PimMultiEdit.aspx")] [AddInTarget("/Admin/Module/eCom_Catalog/dw7/PIM/PimProduct_Edit.aspx")] public class CustomPimProductEditRibbonBarAddin : RibbonBarAddIn { private RibbonBar ribbon; public CustomPimProductEditRibbonBarAddin(RibbonBar ribbon) : base(ribbon) { this.ribbon = ribbon; } public override void Load() { RibbonBarGroup ribbonBarGroup = base.CreateDefaultContainer(); ribbonBarGroup.Name = "Custom"; RibbonBarButton saveButton = new RibbonBarButton(); saveButton.OnClientClick = $"alert('yeah! it is custom'); return false;"; saveButton.EnableServerClick = true; saveButton.Text = "Custom button in PRODUCT edit"; saveButton.Icon = KnownIcon.Extension; saveButton.Size = Dynamicweb.Controls.Icons.Icon.Size.Large; ribbonBarGroup.AddItem(saveButton); } } }