Table of Contents

Class VisualQueryAttribute

Namespace
ToSic.Eav.DataSource.VisualQuery
Assembly
ToSic.Eav.DataSources.dll

Custom Attribute for DataSources and use in the VisualQuery Designer. Will add information about help, configuration-content-types etc. Only DataSources which have this attribute will be listed in the designer-tool.

Read more here: DataSource API: VisualQuery Attribute

[PublicApi]
[AttributeUsage(AttributeTargets.Class|AttributeTargets.Interface)]
public class VisualQueryAttribute : Attribute, _Attribute, IHasIdentityNameId
Inheritance
VisualQueryAttribute
Implements

Properties

Audience

This marks the audience of a DataSource. Specifically it allows hiding advanced DataSources from users who don't need them.

public Audience Audience { get; set; }

Property Value

Audience

Remarks

Previously hidden/unofficial and called Difficulty. Made public and renamed to Audience in v15.03

ConfigurationType

Name of the content-type used to configure this data-source in the visual-query designer.
The UI will then open an edit-dialog for this content type. Should be a GUID.

public string ConfigurationType { get; set; }

Property Value

string

Remarks

Older data sources have a name like "|Config ToSic.Eav.DataSources.App", but that's deprecated

DynamicIn 

public bool DynamicIn { get; set; }

Property Value

bool

DynamicOut

Determine if this data sources can have many out-streams with custom names. Default is false.

public bool DynamicOut { get; set; }

Property Value

bool

True if this data source can also provide other named out-streams, false if it only has the defined list of out-streams.

The help-link to get help for this data source. The UI will offer a help-button if provided.

public string HelpLink { get; set; }

Property Value

string

Icon

Optional custom icon, based on the icon-names from the Material Icons library.

public string Icon { get; set; }

Property Value

string

In

List of in-streams expected by this data-source - will be shown in the UI. Default is empty [].

public string[] In { get; set; }

Property Value

string[]

NameId

required this should be a unique id, ideally a GUID. 

public string NameId { get; set; }

Property Value

string

Remarks

  • important: old code use string names like a.net namespace. This should not be done any more and will be deprecated in future.
  • Was renamed in 15.04 from GlobalName to the new NameId convention.

NameIds

Names this DataSource may have had previously.
This was introduced when we standardized the names, and still had historic data using old names or old namespaces.

public string[] NameIds { get; set; }

Property Value

string[]

Remarks

  • Was renamed in 15.04 to NameIds from PreviousNames

NiceName

Nice name shown in the UI
If not specified, the UI will use the normal name instead.

public string NiceName { get; set; }

Property Value

string

Type

A primary type of this source, which determines a default icon + some standard help-text

public DataSourceType Type { get; set; }

Property Value

DataSourceType

The type, from the DataSourceType enum

UiHint

A hint to help the user better understand what this does - in case the nice name isn't enough.

public string UiHint { get; set; }

Property Value

string
Edit this page