Class ScribanDocumentSectionRenderer

Inheritance

object

ScribanDocumentSectionRenderer

ScribanWebDocumentSectionRenderer

Implements

IDocumentSectionRenderer

ITransientDependency

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Volo.Docs.Documents.Rendering

Assembly: Volo.Docs.Domain.Shared.dll

Syntax

public class ScribanDocumentSectionRenderer : IDocumentSectionRenderer, ITransientDependency

Constructors

ScribanDocumentSectionRenderer()

Declaration

public ScribanDocumentSectionRenderer()

Fields

DocsJsonSections

Declaration

protected static readonly List<ScribanDocumentSectionRenderer.DocsJsonSection> DocsJsonSections

Field Value

Type	Description
List<ScribanDocumentSectionRenderer.DocsJsonSection>

DocsNav

Declaration

protected const string DocsNav = "//[doc-nav]"

Field Value

Type	Description
string

DocsParam

Declaration

protected const string DocsParam = "//[doc-params]"

Field Value

Type	Description
string

DocsTemplates

Declaration

protected const string DocsTemplates = "//[doc-template]"

Field Value

Type	Description
string

Properties

Logger

Declaration

public ILogger<ScribanDocumentSectionRenderer> Logger { get; set; }

Property Value

Type	Description
ILogger<ScribanDocumentSectionRenderer>

Methods

GetAvailableParametersAsync(string)

Declaration

public Task<Dictionary<string, List<string>>> GetAvailableParametersAsync(string document)

Parameters

Type	Name	Description
string	document

Returns

Type	Description
Task<Dictionary<string, List<string>>>

GetJsonBeginEndIndexesAndPureJson(string, string)

Declaration

protected static (int, int, string, ScribanDocumentSectionRenderer.DocsJsonSection) GetJsonBeginEndIndexesAndPureJson(string document, string sectionName)

Parameters

Type	Name	Description
string	document
string	sectionName

Returns

Type	Description
(int, int, string, ScribanDocumentSectionRenderer.DocsJsonSection)

GetSectionAsync<T>(string, string)

Declaration

protected virtual Task<T> GetSectionAsync<T>(string document, string sectionName) where T : new()

Parameters

Type	Name	Description
string	document
string	sectionName

Returns

Type	Description
Task<T>

Type Parameters

Name	Description
T

HasJsonSection(string)

Declaration

protected static bool HasJsonSection(string document)

Parameters

Type	Name	Description
string	document

Returns

Type	Description
bool

RemoveOptionsJson(string, params string[])

Declaration

protected static string RemoveOptionsJson(string document, params string[] sectionNames)

Parameters

Type	Name	Description
string	document
string[]	sectionNames

Returns

Type	Description
string

RenderAsync(string, DocumentRenderParameters, List<DocumentPartialTemplateContent>)

Declaration

public Task<string> RenderAsync(string document, DocumentRenderParameters parameters = null, List<DocumentPartialTemplateContent> partialTemplates = null)

Parameters

Type	Name	Description
string	document
DocumentRenderParameters	parameters
List<DocumentPartialTemplateContent>	partialTemplates

Returns

Type	Description
Task<string>

SetPartialTemplates(string, IReadOnlyCollection<DocumentPartialTemplateContent>)

Declaration

protected static string SetPartialTemplates(string document, IReadOnlyCollection<DocumentPartialTemplateContent> templates)

Parameters

Type	Name	Description
string	document
IReadOnlyCollection<DocumentPartialTemplateContent>	templates

Returns

Type	Description
string

Implements

IDocumentSectionRenderer

ITransientDependency

Extension Methods

AbpObjectExtensions.As<T>(object)

AbpObjectExtensions.To<T>(object)

LockExtensions.Locking(object, Action)

LockExtensions.Locking<TResult>(object, Func<TResult>)

AbpObjectExtensions.If<T>(T, bool, Action<T>)

AbpObjectExtensions.If<T>(T, bool, Func<T, T>)

AbpObjectExtensions.IsIn<T>(T, IEnumerable<T>)

AbpObjectExtensions.IsIn<T>(T, params T[])

AbpQueryableExtensions.OrderByIf<T, TQueryable>(TQueryable, bool, string)

AbpQueryableExtensions.PageBy<T, TQueryable>(TQueryable, int, int)

AbpQueryableExtensions.WhereIf<T, TQueryable>(TQueryable, bool, Expression<Func<T, bool>>)

AbpQueryableExtensions.WhereIf<T, TQueryable>(TQueryable, bool, Expression<Func<T, int, bool>>)

AbpOpenIddictQueryableExtensions.SkipIf<T, TQueryable>(TQueryable, bool, int?)

AbpOpenIddictQueryableExtensions.TakeIf<T, TQueryable>(TQueryable, bool, int?)

LockExtensions.Locking<T>(T, Action<T>)

LockExtensions.Locking<T, TResult>(T, Func<T, TResult>)