ViewEngineDescriptorExtensions Class

Summary

Extension methods for adding view engines to a descriptor collection.

Syntax

public class ViewEngineDescriptorExtensions

GitHub

View on GitHub

class Microsoft.AspNet.Mvc.ViewEngineDescriptorExtensions

Methods

Add(System.Collections.Generic.IList<Microsoft.AspNet.Mvc.ViewEngineDescriptor>, Microsoft.AspNet.Mvc.Rendering.IViewEngine)

Adds an [Microsoft.AspNet.Mvc.Rendering.IViewEngine](Microsoft.AspNet.Mvc.Rendering.IViewEngine.yml) to a descriptor collection.

Arguments:
  • descriptors (System.Collections.Generic.IList{Microsoft.AspNet.Mvc.ViewEngineDescriptor}) – A list of ViewEngineDescriptors
  • viewEngine (Microsoft.AspNet.Mvc.Rendering.IViewEngine) – An [Microsoft.AspNet.Mvc.Rendering.IViewEngine](Microsoft.AspNet.Mvc.Rendering.IViewEngine.yml) instance.
Return type:

Microsoft.AspNet.Mvc.ViewEngineDescriptor

Returns:

ViewEngineDescriptor representing the added instance.

public static ViewEngineDescriptor Add(IList<ViewEngineDescriptor> descriptors, IViewEngine viewEngine)
Add(System.Collections.Generic.IList<Microsoft.AspNet.Mvc.ViewEngineDescriptor>, System.Type)

Adds a type representing a [Microsoft.AspNet.Mvc.Rendering.IViewEngine](Microsoft.AspNet.Mvc.Rendering.IViewEngine.yml) to a descriptor collection.

Arguments:
  • descriptors (System.Collections.Generic.IList{Microsoft.AspNet.Mvc.ViewEngineDescriptor}) – A list of ViewEngineDescriptors
  • viewEngineType (System.Type) – Type representing an [Microsoft.AspNet.Mvc.Rendering.IViewEngine](Microsoft.AspNet.Mvc.Rendering.IViewEngine.yml).
Return type:

Microsoft.AspNet.Mvc.ViewEngineDescriptor

Returns:

ViewEngineDescriptor representing the added instance.

public static ViewEngineDescriptor Add(IList<ViewEngineDescriptor> descriptors, Type viewEngineType)
Insert(System.Collections.Generic.IList<Microsoft.AspNet.Mvc.ViewEngineDescriptor>, System.Int32, Microsoft.AspNet.Mvc.Rendering.IViewEngine)

Insert an [Microsoft.AspNet.Mvc.Rendering.IViewEngine](Microsoft.AspNet.Mvc.Rendering.IViewEngine.yml) to a descriptor collection.

Arguments:
  • descriptors (System.Collections.Generic.IList{Microsoft.AspNet.Mvc.ViewEngineDescriptor}) – A list of ViewEngineDescriptors
  • index (System.Int32) –
  • viewEngine (Microsoft.AspNet.Mvc.Rendering.IViewEngine) – An [Microsoft.AspNet.Mvc.Rendering.IViewEngine](Microsoft.AspNet.Mvc.Rendering.IViewEngine.yml) instance.
Return type:

Microsoft.AspNet.Mvc.ViewEngineDescriptor

Returns:

ViewEngineDescriptor representing the added instance.

public static ViewEngineDescriptor Insert(IList<ViewEngineDescriptor> descriptors, int index, IViewEngine viewEngine)
Insert(System.Collections.Generic.IList<Microsoft.AspNet.Mvc.ViewEngineDescriptor>, System.Int32, System.Type)

Inserts a type representing a [Microsoft.AspNet.Mvc.Rendering.IViewEngine](Microsoft.AspNet.Mvc.Rendering.IViewEngine.yml) to a descriptor collection.

Arguments:
  • descriptors (System.Collections.Generic.IList{Microsoft.AspNet.Mvc.ViewEngineDescriptor}) – A list of ViewEngineDescriptors
  • index (System.Int32) –
  • viewEngineType (System.Type) – Type representing an [Microsoft.AspNet.Mvc.Rendering.IViewEngine](Microsoft.AspNet.Mvc.Rendering.IViewEngine.yml).
Return type:

Microsoft.AspNet.Mvc.ViewEngineDescriptor

Returns:

ViewEngineDescriptor representing the inserted instance.

public static ViewEngineDescriptor Insert(IList<ViewEngineDescriptor> descriptors, int index, Type viewEngineType)
Microsoft.AspNet.Mvc.ViewEngineDescriptorExtensions.InstanceOfOrDefault<TInstance>(System.Collections.Generic.IList<Microsoft.AspNet.Mvc.ViewEngineDescriptor>)

Returns the only instance of <typeparamref name=”TInstance” /> from <paramref name=”descriptors” /> or <c>null</c> if the sequence is empty.

Arguments:
  • descriptors (System.Collections.Generic.IList{Microsoft.AspNet.Mvc.ViewEngineDescriptor}) – The [System.Collections.Generic.IList`1]() to search.
Return type:

TInstance

public static TInstance InstanceOfOrDefault<TInstance>(IList<ViewEngineDescriptor> descriptors)
Microsoft.AspNet.Mvc.ViewEngineDescriptorExtensions.InstanceOf<TInstance>(System.Collections.Generic.IList<Microsoft.AspNet.Mvc.ViewEngineDescriptor>)

Returns the only instance of <typeparamref name=”TInstance” /> from <paramref name=”descriptors” />.

Arguments:
  • descriptors (System.Collections.Generic.IList{Microsoft.AspNet.Mvc.ViewEngineDescriptor}) – The [System.Collections.Generic.IList`1]() to search.
Return type:

TInstance

Returns:

The only instance of <typeparamref name=”TInstance” /> in <paramref name=”descriptors” />.

public static TInstance InstanceOf<TInstance>(IList<ViewEngineDescriptor> descriptors)
Microsoft.AspNet.Mvc.ViewEngineDescriptorExtensions.InstancesOf<TInstance>(System.Collections.Generic.IList<Microsoft.AspNet.Mvc.ViewEngineDescriptor>)

Returns all instances of <typeparamref name=”TInstance” /> from <paramref name=”descriptors” />.

Arguments:
  • descriptors (System.Collections.Generic.IList{Microsoft.AspNet.Mvc.ViewEngineDescriptor}) – The [System.Collections.Generic.IList`1]() to search.
Return type:

System.Collections.Generic.IEnumerable{{TInstance}}

Returns:

An IEnumerable of <typeparamref name=”TInstance” /> that contains instances from <paramref name=”descriptors” />.

public static IEnumerable<TInstance> InstancesOf<TInstance>(IList<ViewEngineDescriptor> descriptors)