Interface IView

Namespace

ToSic.Sxc.Blocks

Assembly

ToSic.Sxc.dll

Defines a view configuration which is loaded from an EntityBasedType.

[PublicApi_Stable_ForUseInYourCode]
public interface IView : IHasDecorators<IEntity>

Inherited Members

IHasDecorators<IEntity>.Decorators

Properties

Icon

An optional Icon for this View configuration. Would be used instead of the file name in the App-folder. WIP

string Icon { get; }

Property Value

string

Remarks

New in 12.02

Identifier

An optional unique identifier for this View configuration.

string Identifier { get; }

Property Value

string

Remarks

New in 12.02

IsHidden

Determine if we should hide this view/template from the pick-UI.

bool IsHidden { get; }

Property Value

bool

IsShared

Translates the location to tell us if it's a shared view (the template is in a shared location)

bool IsShared { get; }

Property Value

bool

Name

The name, localized in the current UI language.

string Name { get; }

Property Value

string

Path

Path to the template

string Path { get; }

Property Value

string

Query

The query attached to this view (if one was specified)

QueryDefinition Query { get; }

Property Value

QueryDefinition

A query object or null

SearchIndexingDisabled

Determines if search indexing should be disabled - so this view will not provide search data.

bool SearchIndexingDisabled { get; }

Property Value

bool

SearchIndexingStreams

Streams which should be included in the search index. If empty will use all streams. CSV

string SearchIndexingStreams { get; }

Property Value

string

Type

The underlying type name of the template, ATM they are unfortunately hard-coded as "C# Razor" and "Token"

string Type { get; }

Property Value

string

ViewController

The external class which should be compiled / used to customize search.

In future this could do more, which is why it's called ViewController and not SearchController or something.

string ViewController { get; }

Property Value

string