Page Comparison

Table of Contents

Dimensionen / Spalten definieren bevor weiter dokumentiert wird!

Mehrere Dimensionen zu den Aspekten definieren

TODO Spalten und Inhalte genau definieren
1. Sebastian Greulach Vorab Liste erstellen, Reviewen
TODO Tabelle suchen, bei der man nach mehreren Dimensionen Filtern kann

Zielpublikum: Developer

...

Neu: Use Case: Global Search, …

...

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 /

...

Braucht es das?

Funktionen in der Liste???

...

→ Nicht textuell Eher nicht beschreiben was es macht, sondern wo es geht

...

Beispiel

(Extension)

Anwendbar auf

Detail, Liste, Property, Cell

...

Bsp FontColorAspect - Welches Control kann das überhaupt?

...

Anwendbarkeit bietet grossen Mehrwert da das sonst Reverse Engeneered werden muss

...

Funktionen im Detail???

Siehe oben

...

Def??? - Definition - Aus welchem Projekt kommt das, Wo suchen wie das implementiert ist

...

Neu: Internal

Neu: XML

...

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.

Image Added

Anwendbar auf Controls:

QuinoTextBox
QuinoDropdown
QuinoSearchEdit
QuinoMultiSelect
QuinoMultiLineRichtTextEditor

Benutzung über PropertyLinkBuilderExtensions

Code Block

language	c#

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

language	xml

<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

...

Aspect	Beschreibung	Verwendungen/ Extensions	Funktionen in der Liste	Funktionen im Detail	Def
`AbsoluteNavigationLinkAspect: NavigationLinkAspect` Eigenschaften: `URL`- die absolute URL oder URL-Ausdruck zum Öffnen. `EvaluateMetaValuePropertiesInContext`()	Es stellt einen Aspekt mit einer absoluten URL oder einen Ausdruck dar, der zu einer absoluten URL ausgewertet wird. NavigationLinkAspect	`.SetAbsoluteNavigationLink()` 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.	`.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.	`.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 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.	`.BookmarkActions()` in LayoutBuilderExtensions			QW
`BreadcrumbParentAspect`		`.BreadcrumbParent()`			QW
`CacheInvalidationAspect`		`.Aspect(() => new CacheInvalidationAspect()`			QW
`CalenderExportAspect`		Used in its own file			QW
`CheckboxConfigurationAspect`		`.CheckboxOptions()`			QW
`ClassActionAspect`		`.IsClassAction()`			QW
`ClassNavigationLinkAspect: 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
`CollapsibleAspect`		`.Collapsible()`			QW
`ConfirmationActionAspect`		`.RequiresConfirmation()`			QW
`CssClassAspect`	Enthält einen speziellen CSS-Klassennamen für ein gegebenes Layout-Element.	`.CssClass()`			QW
`CustomTitleAspect`		`.CustomTitle()` - keine Verwendungen im Code			QW
`DashboardSizingAspect`		`.SetDashboardSizing()`			QW
`DataTestIdAspect`		`.DataTestId()` - keine Verwendungen im Code. Für UI Testing.			QW
`DatePickerConfigurationAspect`		`.DatePickerConfiguration()`			QW
`DefaultAspect`		`.SetDefault()`			QW
`DependencyAspect`		`.Dependency()` `.FindOrAddAspect(() => new DependencyAspect())`			QW
`DrilldownColumnAspect`		`.IsDrilldownColum()`			QW
`DropdownConfigurationAspect`		`.DropdownConfiguration()`			QW
`ExpressionBasedLayoutScopeAspect`		`.Scope()`			QW
`FacetFilterAspect`	Fügt eine Property in einem ListenLayout zum Facettenfilter hinzu.	`.FacetFilter()`			QW
`FileUploadConfigurationAspect`		`.FindOrAddAspect(() => new FileUploadConfigurationAspect`)			QW
`FontColorAspect`		`.FontColor()` - keine Verwendungen im Code `.FontColorExpression()`			QW
`FormatAspectConverter`		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`		`.SetLabelOptions()`			QW
`ListActionAspect`		`.SetListAction()`			QW
`ListConfigurationAspect`		`.ListConfiguration()`			QW
`ListTitleAspect`		`.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	`.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
`NotificationClassAspect`		`.IsNotificationClass()`			QW
`NumberGroupCreateEventClassAspect`		`.AssignNumberGroup()`			QW
`NumberGroupDefinitionModelAspect`		`.AssignNumberGroup()` Used in NumberGroupCreateEventClass.cs Used in NumberGroupDataGenerator.cs			QW
`ObjectNavigationLinkAspect: 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()`			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
`ResponsiveLocationAspect`		`.FindOrAddAspect<IResponsiveLocationAspect>(() => new ResponsiveLocationAspect())`			QW
`RichTextEditorConfigurationAspect`		`.SetRichTextEditorConfiguration()`			QW
`ScrollableAspect`		`.IsScrollable()`			QW
`SidebarConfigurationAspect`		.`ConfigureSidebar()`			QW
`SimpleChangeTrackingAspect`		Used in SimpleChangeTrackingExtensions.cs			QW
`SortedValueListPropertyAspect`		`.SetAspect(new SortedValueListPropertyAspect())`			QW
`VisibleInExplorerAspect`		`.Aspect(() => new VisibleInExplorerAspect(`) `.IsVisibleInExplorer()` `.InverseIsVisibleInExplorer()` - keine Verwendungen im Code			QW
`WarningAspect`		`.Warning()`			QW
`WidthAspect`	CSS Width Informationen	`.Width()`			QW

Quino Standard

Aspect	Converter	Verwendungen	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

...

Versions Compared

Old Version 20

New Version Current

Key

Dimensionen / Spalten definieren bevor weiter dokumentiert wird!

Vorschlag Dokumentationsstruktur

Aspekte auf Klassen

Aspekte auf Properties und Layout-Elementen

Quino Standard