IFrameTemplate Interface

Declares members implemented by Frame Templates.

Namespace: DevExpress.ExpressApp.Templates

Assembly: DevExpress.ExpressApp.v22.1.dll

Declaration

C#

public interface IFrameTemplate

VB.NET

Public Interface IFrameTemplate

Related API Members

The following members return IFrameTemplate objects:

• CreateCustomTemplateEventArgs.Template
• CustomizeTemplateEventArgs.Template
• Frame.Template
• XafApplication.CreateTemplate(String)

Remarks

The eXpressApp Framework design is based on the concept of abstract elements and actual controls. A Frame (Window) is an abstract entity. It can be displayed by any control. However, to support the relation with eXpressApp Framework elements, this contol must implement the IFrameTemplate interface.

The IFrameTemplate interface has a descendant - IWindowTemplate, which declares members needed to display independent Windows.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the IFrameTemplate interface.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

XAF_how-to-create-a-custom-a-winforms-standard-template-t196002/CS/CustomizeWinFormsTemplateExample.Win/DetailForm1.cs#L53

#region IFrameTemplate Members
void IFrameTemplate.SetView(DevExpress.ExpressApp.View view) {
    viewSiteManager.SetView(view);

XAF_how-to-create-a-custom-winforms-ribbon-template-e216/CS/CustomizeRibbonTemplateExample.Win/DetailRibbonForm1.cs#L63

#region IFrameTemplate Members
void IFrameTemplate.SetView(DevExpress.ExpressApp.View view)
{

XAF_how-to-create-information-panels-e2690/CS/InfoPanels.Module.Web/Controllers/InfoPanelViewControllerWeb.cs#L15

namespace InfoPanels.Module.Web.Controllers {
    public interface IInfoPanelTemplateWeb : IFrameTemplate {
        Control PlaceHolder {

XAF_how-to-access-the-documentmanager-barmanager-and-ribboncontrol-e4027/CS/TabsLayoutCustomization.Module.Win/Controllers/TabsCustomizationWindowController.cs#L19

private void Window_TemplateChanged(object sender, EventArgs e) {
    IFrameTemplate template = Window.Template;
    DocumentManager docManager = ((IDocumentsHostWindow)template).DocumentManager;

VB.NET

XAF_how-to-create-a-custom-a-winforms-standard-template-t196002/VB/CustomizeWinFormsTemplateExample.Win/DetailForm1.vb#L60

#Region "IFrameTemplate Members"
    Private Sub IFrameTemplate_SetView(view As DevExpress.ExpressApp.View) Implements IFrameTemplate.SetView
        ViewSiteManager.SetView(view)

XAF_how-to-create-information-panels-e2690/VB/InfoPanels.Module.Web/Controllers/InfoPanelViewControllerWeb.vb#L13

Public Interface IInfoPanelTemplateWeb
    Inherits IFrameTemplate

XAF_how-to-access-the-documentmanager-barmanager-and-ribboncontrol-e4027/VB/TabsLayoutCustomization.Module.Win/Controllers/TabsCustomizationWindowController.vb#L21

Private Sub Window_TemplateChanged(ByVal sender As Object, ByVal e As EventArgs)
    Dim template As IFrameTemplate = Window.Template
    Dim docManager As DocumentManager = DirectCast(template, IDocumentsHostWindow).DocumentManager