TemplateRef

Represents an embedded template that can be used to instantiate embedded views. To instantiate embedded views based on a template, use the ViewContainerRef method createEmbeddedView().

See more...

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

See also

• ViewContainerRef

• Navigate the Component Tree with DI

Description

Access a TemplateRef instance by placing a directive on an <ng-template> element (or directive prefixed with *). The TemplateRef for the embedded view is injected into the constructor of the directive, using the TemplateRef token.

You can also use a Query to find a TemplateRef associated with a component or a directive.

Properties

Property

Description

abstract elementRef: ElementRef

Read-Only The anchor element in the parent view for this embedded view. 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.

Methods

createEmbeddedView()
Instantiates an embedded view based on this template, and attaches it to the view container.
abstract createEmbeddedView(context: C): EmbeddedViewRef<C> Parameters context C The data-binding context of the embedded view, as declared in the <ng-template> usage. Returns EmbeddedViewRef<C>: The new embedded view object.