Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

Vorschlag Dokumentationsstruktur

TODOs siehe https://dev.azure.com/encodo/Quino/_workitems/edit/13481

Use Case

Scope

Menu, Class, Modell, Property, …

TODO: Ist das das Gleiche wie “Anwendbar auf”?

Aspect

Mit Properties

Beschreibung

Verwendung / Beispiel

(Extension)

Anwendbar auf

Detail, Liste, Property, Cell

Definition in

QW = Quino Web

QS = Quino Standard

Internal

???

Class

MergingAspect

Markiert eine MetaClass um es möglich machen Objekte zusammenzuführen

Wenn Objekte in der Liste selektiert sind können sie zusammengeführt werden.

.Mergeable()

?

QW 

Public

Help

Property

PlaceholderAspect

Properties:

  • Placeholder: DynamicString

Fügt ein Placeholder bzw. Wasserzeichen zu leeren Inputs wie z.B. Textfeldern hinzu.

Screenshot 2024-10-08 125426.pngImage Added

Anwendbar auf Controls:

  • QuinoTextBox

  • QuinoDropdown

  • QuinoSearchEdit

  • QuinoMultiSelect

  • QuinoMultiLineRichtTextEditor

Benutzung über PropertyLinkBuilderExtensions

Code Block
languagec#
row.Add.Link(metadata.Controls.Text_Nullable)
  .Placeholder(English, "Placeholder for a text box")
  .Placeholder(German, "Platzhalter für eine Text-Box");

XML:

Code Block
languagexml
<layout name="TestPlaceholders" type="Detail" targetClass="Office">
  <propertyLink link="Name">
    <aspects>
      <placeholderAspect>
        <placeholder en-CH="What is the name?" de-CH="Was ist der Name?"></placeholder>
      </placeholderAspect>
    </aspects>
  </propertyLink>
</layout>

Property

QW

Public

Aspekte auf Klassen

TODO

Aspekte auf Properties und Layout-Elementen

Quino Web

Aspect

BeschreibungConverter

Verwendungen/ Extensions

Funktionen in der Liste

Funktionen im Detail

AbsoluteNavigationLinkAspectTargetAbsoluteNavigationLinkAspect: NavigationLinkAspect

Eigenschaften:

  • URL- die absolute URL oder URL-Ausdruck zum Öffnen. UrlExpression- der absolute URL-Ausdruck.

  • EvaluateMetaValuePropertiesInContext()

Es stellt einen Aspekt mit einer absoluten URL oder einen Ausdruck dar, der zu einer absoluten URL ausgewertet wird.

AbsoluteNavigationLinkAspectTargetConverterNavigationLinkAspect

.SetAbsoluteNavigationLink() - bei Verwendung mit einer normalen URL.

.SetAbsoluteNavigationLinkExpression() - bei Verwendung mit einem URL-Ausdruck.

-

  • in PropertyLinkBuilderExtensions

Fügt dem PropertyLink-Element eine absolute URL hinzu.

QW

AggregationColumnAspect

Eigenschaften:

  • ColumnName - Name der Spalte, die aggregiert werden soll.

  • AggregationMethod - Methode der Aggregation ("sum", "count", "min", "max" oder "average").

Fügt den Aggregationsaspekt hinzu.

AggregationColumnAspectConverter

.Aggregation()

Aggregiert die Spalte mit "sum", "count", "min", "max" oder "average".

-

QW

AlignmentAspect

Eigenschaften:

  • HorizontalAlignment - Die horizontale Ausrichtung des Elements (ENUM: “left“, “center“, “right“).

  • VerticalAlignment - Die vertikale Ausrichtung des Elements (ENUM: “top“, “middle“, “bottom“).

Enthält Informationen zur horizontalen und/oder vertikalen Ausrichtung innerhalb eines Layout-Elements.

JsonConverterProvider

.Alignment(.

.Alignment()

QW

AuthorizeAspect

Autorisiert eine Klasse ohne das die entsprechenden Berechtigungen gesetzt werden müssen.

Die Klasse ist danach für alle authentifizierten Benutzer verfügbar.

.Authorize(...)

BackgroundColorAspect

  • soll an verschiedenen Orten eingesetzt werden können

-

.BackgroundColor()

.BackgroundColorExpression()

QW

BookmarkActionsAspect

Legt den visible oder disabled für Standard-Bookmark-Actions im Objekt-Bookmark fest. Fügt ausserdem die Möglichkeit hinzu, die Schaltfläche nur als Symbol ohne Text zu erstellen.BookmarkActionsAspectConverter

.BookmarkActions() in LayoutBuilderExtensions

QW

BreadcrumbParentAspectBreadcrumbParentAspectConverter

.BreadcrumbParent()

QW

CacheInvalidationAspect-

.Aspect(() => new CacheInvalidationAspect()

QW

CalenderExportAspect-

Used in its own file

QW

CheckboxConfigurationAspectCheckboxConfigurationAspectConverter

.CheckboxOptions()

QW

ClassActionAspect

ClassActionAspectConverter

.IsClassAction()

QW

ClassNavigationLinkAspect

ClassNavigationLinkAspectConverter

.SetClassNavigationLink() - keine Verwendungen im Code

.SetTarget()

ClassNavigationLinkAspectTarget

ClassNavigationLinkAspectConverter

Used in ClassNavigationLinkAspect.cs

ClientSecretHashingAspect

-: NavigationLinkAspect

  • MetaClass - die absolute MetaClass oder MetaClass -Ausdruck.

  • Layout- die absolute Layout oder Layout -Ausdruck.

  • MetaFilter- die absolute MetaFilter

  • EvaluateMetaValuePropertiesInContext()

NavigationLinkAspect

.SetClassNavigationLink()

  • in PropertyLinkBuilderExtensions

Fügt dem PropertyLink-Element eine class navigation URL hinzu.

QW

ClientSecretHashingAspect

.Aspect(() => new ClientSecretHashingAspect())

QW

CollapsibleAspectCollapsibleAspectConverter

.Collapsible()

QW

ConfirmationActionAspectConfirmationActionAspectConverter

.RequiresConfirmation()

QW

CssClassAspect

Enthält einen speziellen CSS-Klassennamen für ein gegebenes Layout-Element.CssClassAspectConverter

.CssClass()

QW

CustomTitleAspectCustomTitleAspectConverter

.CustomTitle() - keine Verwendungen im Code

QW

DashboardSizingAspectDashboardSizingAspectConverter

.SetDashboardSizing()

QW

DataTestIdAspectDataTestIdAspectConverter

.DataTestId() - keine Verwendungen im Code. Für UI Testing.

QW

DatePickerConfigurationAspectDatePickerConfigurationAspectConverter

.DatePickerConfiguration()

QW

DefaultAspectDefaultAspectConverter

.SetDefault()

QW

DependencyAspectDependencyAspectConverter

.Dependency()

.FindOrAddAspect(() => new DependencyAspect())

QW

DrilldownColumnAspectDrilldownColumnAspectConverter

.IsDrilldownColum()

QW

DropdownConfigurationAspect

DropdownConfigurationAspectConverter

.DropdownConfiguration()

QW

ExpressionBasedLayoutScopeAspectExpressionBasedLayoutScopeAspectConverter

.Scope()

QW

FacetFilterAspect

Fügt eine Property in einem ListenLayout zum Facettenfilter hinzu.

-

.FacetFilter()

QW

FileUploadConfigurationAspect

FileUploadOptionsConverter

.FindOrAddAspect(() => new FileUploadConfigurationAspect)

QW

FontColorAspect

-

.FontColor() - keine Verwendungen im Code

.FontColorExpression()

QW

FormatAspectConverterSame file

Keine Verwendungen im Code

QW

GlobalSearchClassAspect-

.Searchable()

QW

GlobalSearchDeltaUpdateCollectorAspect-

.Searchable()

QW

GlobalSearchFilteredPropertyAspect-

.Searchable()

QW

GlobalSearchPropertyAspect-

.Searchable()

Used in GlobalSearchProvider.cs

QW

HealthCheckClassAspect-

In ApplicationController:

var result = classes.FirstOrDefault(cls => _aspectCalculator.TryGetAspect<HealthCheckClassAspect>(cls, out _));

QW

HeightAspect

CSS Height Informationen

.Height()

QW

LabelConfigurationAspect

LabelConfigurationAspectConverter

.SetLabelOptions()

QW

ListActionAspectListActionAspectConverter

.SetListAction()

QW

ListConfigurationAspectDataGridConfigurationAspectConverter

.ListConfiguration()

QW

ListTitleAspect

ListTitleAspectConverter

.SetListCaption() - keine Verwendungen im Code

QW

MarginAspect

Enthält Margin-Informationen für ein bestimmtes Layout-Element.

Aktuell nur in PublicWidgets berücksichtigt.

--

QW

MaskFormatAspect

Rename to MaskAspect

MaskFormatAspectConverter

.Mask()

MetaSortAspect

MetaLayoutConverter

.Mask()

QW

MergingAspect

Markiert eine MetaClass um es möglich machen Objekte zusammenzuführen

.Mergeable()

Wenn Objekte in der Liste selektiert sind können sie zusammengeführt werden.

QW

MetaSortAspect

.AddWebSort()

QW

MultiLineColumnOptionsAspect

Enthält Optionen für eine Multiline-Spalte in einer Liste.-

.MultiLineColumnOptions()

QW

NotificationClassAspectNotificationClassAspectConverter

.IsNotificationClass()

QW

NumberGroupCreateEventClassAspect

-

.AssignNumberGroup()

QW

NumberGroupDefinitionModelAspect-

.AssignNumberGroup()

Used in NumberGroupCreateEventClass.cs

Used in NumberGroupDataGenerator.cs

QW

ObjectNavigationLinkAspect

ObjectNavigationLinkAspectConverter

.SetObjectNavigationLink()

ObjectNavigationLinkAspectTarget

ObjectNavigationLinkAspectConverter

Used in ObjectNavigationLinkAspect.cs: NavigationLinkAspect

  • MetaClass- die absolute MetaClass oder MetaClass -Ausdruck zum Öffnen.

  • PrimaryKey- die absolute PrimaryKey oder PrimaryKey -Ausdruck zum Öffnen.

  • Layout- die absolute Layout oder Layout -Ausdruck zum Öffnen.

  • TabIndex- die absolute TabIndex .

  • EvaluateMetaValuePropertiesInContext()

NavigationLinkAspect

.SetObjectNavigationLink()

  • in PropertyLinkBuilderExtensions

Fügt dem PropertyLink-Element eine object navigation link hinzu.

QW

PaddingAspect

Enthält Padding-Informationen für ein bestimmtes Layout-Element.

Aktuell nur in PublicWidgets berücksichtigt.

--

QW

PublicWidgetOptionsAspect

Enthält Optionen zum Styling eines öffentlichen Listen- oder Detail-Layouts.

.

-

.PublicWidgetOptions()

ResponsiveBoxAspect

ResponsiveBoxAspectConverter

PublicWidgetOptions()

QW

RegularExpressionRuleAspect

Enthält Reguläre Ausdrücke zu Validieren von Properties oder MetaClasses

.IsValid()

.Validate()

Validierung von Textfeldern im Inline Edit

Validierung von Textfeldern

QW

ResponsiveBoxAspect

.FindOrAddAspect<IResponsiveBoxAspect>(() => new ResponsiveBoxAspect())

QW

ResponsiveLocationAspectResponsiveLocationAspectConverter

.FindOrAddAspect<IResponsiveLocationAspect>(() => new ResponsiveLocationAspect())

QW

RichTextEditorConfigurationAspect

RichTextEditorConfigurationAspectConverter

.SetRichTextEditorConfiguration()

QW

ScrollableAspect

ScrollableAspectConverter

.IsScrollable()

QW

SidebarConfigurationAspect

SidebarConfigurationAspectConverter

.ConfigureSidebar()

QW

SimpleChangeTrackingAspect-

Used in SimpleChangeTrackingExtensions.cs

QW

SortedValueListPropertyAspectSortedValueListPropertyAspectConverter

.SetAspect(new SortedValueListPropertyAspect())

QW

VisibleInExplorerAspectVisibleInExplorerAspectConverter

.Aspect(() => new VisibleInExplorerAspect()

.IsVisibleInExplorer()

.InverseIsVisibleInExplorer() - keine Verwendungen im Code

QW

WarningAspect-

.Warning()

QW

WidthAspect

CSS Width Informationen

.WarningWidth()

QW

Quino Standard

Aspect

Converter

Verwendungen

Beschreibung

Def

ColorAspect

ColorAspectConverter (Quino Web)

Used in BackgroundColorAspect.cs and

FontColorAspect.cs

QS

ExpandedAspect

ExpandedAspectConverter (Quino Web)

.IsExpanded()

QS

ExpressionBasedValidationAspect

ExpressionBasedValidationAspectConverter (Quino Web)

Keine Verwendungen im Code

QS

FormatAspect

FormatAspectConverter (Quino Web)

.Format()

QS

IconAspect

IconAspectConverter (Quino Web)

.Icon()

QS

LayoutAspect

LayoutAspectConverter (Quino Web)

.FindOrAddAspect(() => new LayoutAspect(layout)).Layout = layout

.FindOrAddAspect(() => new LayoutAspect(metaLayout))

QS

MaximumSizeAspect

MaximumSizeAspectConverter (Quino Web)

.Size() - keine Verwendungen im Code

QS

MetaFilterAspect

MetaFilterAspectConverter (Quino Web)

.MetaFilter()

QS

ReadOnlyAspect

ReadOnlyAspectConverter (Quino Web)

Used in ModelDependencyCalculatorStartupAction.cs

.IsReadOnly() ?

QS

RuleAspect

RuleAspectConverter (Quino Web)

Used in IMaximumSizeAspect

QS

SizingAspect

SizingAspectConverter (Quino Web)

.FindOrAddAspect(() => new SizingAspect {})

QS

SortOrderAspect

SortOrderAspectConverter (Quino Web)

.AddSortOrderProperty()

QS

ValueListPropertyAspect

ValueListAspectJsonConverter (Quino Web)

Used in GenericController.cs

QS