This is the archived documentation for Angular v5. Please visit angular.io to see documentation for the current version of Angular.

TemplateRef

npm Package @angular/core
Module import { TemplateRef } from '@angular/core';
Source core/src/linker/template_ref.ts

Overview

      
      class TemplateRef<C> {
  get elementRef: ElementRef
  createEmbeddedView(context: C): EmbeddedViewRef<C>
}
    

Description

Represents an Embedded Template that can be used to instantiate Embedded Views.

You can access a TemplateRef, in two ways. Via a directive placed on a <ng-template> element (or directive prefixed with *) and have the TemplateRef for this Embedded View injected into the constructor of the directive using the TemplateRef Token. Alternatively you can query for the TemplateRef from a Component or a Directive via Query.

To instantiate Embedded Views based on a Template, use createEmbeddedView, which will create the View and attach it to the View Container.

Members

      
      get elementRef: ElementRef
    

The location in the View where the Embedded View logically belongs to.

The data-binding and injection contexts of Embedded Views created from this TemplateRef inherit from the contexts of this location.

Typically new Embedded Views are attached to the View Container of this location, but in advanced use-cases, the View can be attached to a different container while keeping the data-binding and injection context from the original location.


      
      createEmbeddedView(context: C): EmbeddedViewRef<C>