From 81781d61a4c6c8c82ec03dfa5ae328c524517b03 Mon Sep 17 00:00:00 2001 From: iJungleboy Date: Thu, 25 Apr 2024 17:57:00 +0200 Subject: [PATCH] minor Gps and TOC improvements --- 2sxc Docs Generator/docfx.json | 4 +- 2sxc Docs Generator/index.md | 2 +- .../basics/data/fields/boolean-tristate.md | 6 +- .../pages/basics/data/fields/custom-gps.md | 8 +- .../pages/basics/data/fields/custom.md | 10 +- .../pages/basics/data/fields/toc.yml | 107 ++++----- 2sxc Docs Generator/pages/basics/data/toc.yml | 4 +- 2sxc Docs Generator/pages/basics/toc.yml | 7 +- .../pages/guides/app-development/toc.yml | 2 +- docs/api/dot-net/Custom.Data.CustomItem.html | 20 +- docs/api/dot-net/Custom.Hybrid.ApiTyped.html | 97 ++++++--- docs/api/dot-net/Custom.Hybrid.CodeTyped.html | 73 +++++-- .../dot-net/Custom.Hybrid.RazorTyped-1.html | 3 + .../api/dot-net/Custom.Hybrid.RazorTyped.html | 61 +++++- .../api/dot-net/ToSic.Sxc.Data.IMetadata.html | 3 + .../dot-net/ToSic.Sxc.Data.ITypedItem.html | 49 ++++- .../dot-net/ToSic.Sxc.Data.ITypedStack.html | 187 ++++++++-------- docs/api/dot-net/ToSic.Sxc.Data.html | 3 +- .../ToSic.Sxc.Services.ILinkService.html | 9 +- docs/basics/data/fields/boolean-tristate.html | 4 +- docs/basics/data/fields/custom-gps.html | 4 +- docs/basics/data/fields/toc.html | 197 ++++++++--------- docs/basics/data/fields/toc.json | 2 +- docs/basics/data/toc.html | 187 ++++++++-------- docs/basics/data/toc.json | 2 +- docs/basics/toc.html | 204 +++++++++--------- docs/basics/toc.json | 2 +- docs/guides/app-development/toc.html | 2 +- docs/guides/app-development/toc.json | 2 +- docs/guides/toc.html | 2 +- docs/guides/toc.json | 2 +- docs/index.html | 2 +- docs/index.json | 24 +-- docs/xrefmap.yml | 75 ++++--- 34 files changed, 787 insertions(+), 579 deletions(-) diff --git a/2sxc Docs Generator/docfx.json b/2sxc Docs Generator/docfx.json index 8f01d0236..a919d039a 100644 --- a/2sxc Docs Generator/docfx.json +++ b/2sxc Docs Generator/docfx.json @@ -2,10 +2,10 @@ "metadata": [ { // use a blank SRC while developing typescript or the theme, to save time - "src": [], + "x-src": [], // The source-code to document - "x-src": [ + "src": [ { "src": "../..", "files": [ diff --git a/2sxc Docs Generator/index.md b/2sxc Docs Generator/index.md index 5b81af2e0..ee415b587 100644 --- a/2sxc Docs Generator/index.md +++ b/2sxc Docs Generator/index.md @@ -3,7 +3,7 @@ # 2sxc and EAV Docs -`For version 17.06.03 LTS` +`For version 17.07 LTS` This is the technical documentation for EAV and 2sxc. If you're new to 2sxc, start with [2sxc.org](https://2sxc.org/). diff --git a/2sxc Docs Generator/pages/basics/data/fields/boolean-tristate.md b/2sxc Docs Generator/pages/basics/data/fields/boolean-tristate.md index c55ebd60c..69f6225fe 100644 --- a/2sxc Docs Generator/pages/basics/data/fields/boolean-tristate.md +++ b/2sxc Docs Generator/pages/basics/data/fields/boolean-tristate.md @@ -3,9 +3,11 @@ uid: Basics.Data.Fields.Boolean-Tristate --- # Field Input-Type **boolean-tristate** -Use this field type for configuring simple true/false UI elements, storing [boolean/boolean data](xref:Basics.Data.Fields.Boolean). It's an extension of the basic [boolean field type](xref:Basics.Data.Fields.Boolean). +Use this field type for configuring simple true/false UI elements, +storing [boolean/boolean data](xref:Basics.Data.Fields.Boolean). +It's an extension of the basic [boolean field type](xref:Basics.Data.Fields.Boolean). -## Features +## Features 1. provide a basic on/off input field (toggle switch) 1. can also be switched to `null` (not set) diff --git a/2sxc Docs Generator/pages/basics/data/fields/custom-gps.md b/2sxc Docs Generator/pages/basics/data/fields/custom-gps.md index acbbe0a97..8d12b8ea3 100644 --- a/2sxc Docs Generator/pages/basics/data/fields/custom-gps.md +++ b/2sxc Docs Generator/pages/basics/data/fields/custom-gps.md @@ -3,10 +3,10 @@ uid: Basics.Data.Fields.CustomGps --- # Field Input-Type **custom-gps** -Use this field type for selecting positions on a map, storing [custom JSON data](xref:Basics.Data.Fields.Custom). +Use this field type for selecting positions on a map, storing [custom JSON data](xref:Basics.Data.Fields.Custom). -## Features +## Features 1. Auto-find the location based on address data already added to the form 1. Pin can be moved manually @@ -17,4 +17,6 @@ Use this field type for selecting positions on a map, storing [custom JSON data] ## History -1. Introduced in 2sxc 2.0 \ No newline at end of file +1. Introduced in 2sxc 2.0 - originally with a virtual field which placed the numbers into 2 number fields +1. Modified behavior to use a JSON field instead ca. 2sxc 7 +1. Improved Razor with `ITypedItem` to have a `.Gps(...)` method 2sxc 17 diff --git a/2sxc Docs Generator/pages/basics/data/fields/custom.md b/2sxc Docs Generator/pages/basics/data/fields/custom.md index 6d391af35..feb315aef 100644 --- a/2sxc Docs Generator/pages/basics/data/fields/custom.md +++ b/2sxc Docs Generator/pages/basics/data/fields/custom.md @@ -11,7 +11,7 @@ This explains **Custom Fields**. For an overview check out [](xref:Basics.Data.I --- -Custom data is a basic [data type](xref:Basics.Data.Fields.Index). It's used to store JSON for special use cases. +Custom data is a basic [data type](xref:Basics.Data.Fields.Index). It's used to store JSON for special use cases. ## Sub-Types @@ -24,16 +24,18 @@ Custom data is a basic [data type](xref:Basics.Data.Fields.Index). It's used to Since 2sxc 10 there is a special `AsDynamic` which you can use to work with JSON data in Razor templates. ---- +--- ## Technical Information ### Storage in the SQL Database in the EAV-Model -This is converted to a string when stored as a string in the DB, and converted back to a boolean when the data is loaded. + +This is converted to a string when stored as a string in the DB, and converted back to a boolean when the data is loaded. ### Storage in the SQL Database in the JSON-Model + This is simply stored as a string value in json, so kind of JSON in JSON. ## History -1. Introduced in EAV 1.0 2sxc 1.0 \ No newline at end of file +1. Introduced in EAV 1.0 2sxc 1.0 diff --git a/2sxc Docs Generator/pages/basics/data/fields/toc.yml b/2sxc Docs Generator/pages/basics/data/fields/toc.yml index b292305eb..2c1c5098f 100644 --- a/2sxc Docs Generator/pages/basics/data/fields/toc.yml +++ b/2sxc Docs Generator/pages/basics/data/fields/toc.yml @@ -3,86 +3,87 @@ topicUid: Basics.Data.Fields.GeneralSettings # Boolean -- name: " " - name: "Boolean Fields" topicUid: Basics.Data.Fields.Boolean -- name: Boolean Default - topicUid: Basics.Data.Fields.Boolean-Default -- name: Boolean Tristate - topicUid: Basics.Data.Fields.Boolean-Tristate + items: + - name: Boolean Default + topicUid: Basics.Data.Fields.Boolean-Default + - name: Boolean Tristate + topicUid: Basics.Data.Fields.Boolean-Tristate -# Boolean -- name: " " +# DateTime - name: "Date/Time Fields" topicUid: Basics.Data.Fields.DateTime -- name: DateTime Default - topicUid: Basics.Data.Fields.DateTime-Default + items: + - name: DateTime Default + topicUid: Basics.Data.Fields.DateTime-Default # Custom -- name: " " -- name: "Custom Fields" +- name: "Custom Fields / GPS" topicUid: Basics.Data.Fields.Custom -- name: Custom GPS - topicUid: Basics.Data.Fields.CustomGps + items: + - name: Custom GPS + topicUid: Basics.Data.Fields.CustomGps # Empty -- name: " " - name: "Empty Fields (Groups)" topicUid: Basics.Data.Fields.Empty -- name: Empty Default (new Group) - topicUid: Basics.Data.Fields.Empty-Default -- name: Empty End (close a Group) - topicUid: Basics.Data.Fields.Empty-End -- name: Empty Message - topicUid: Basics.Data.Fields.Empty-Message + items: + - name: Empty Default (new Group) + topicUid: Basics.Data.Fields.Empty-Default + - name: Empty End (close a Group) + topicUid: Basics.Data.Fields.Empty-End + - name: Empty Message + topicUid: Basics.Data.Fields.Empty-Message # Entity -- name: " " - name: "Entity Fields (Relationships)" topicUid: Basics.Data.Fields.Entity -- name: Entity Default - topicUid: Basics.Data.Fields.Entity-Default -- name: Entity from Query - topicUid: Basics.Data.Fields.Entity-Query + items: + - name: Entity Default + topicUid: Basics.Data.Fields.Entity-Default + - name: Entity from Query + topicUid: Basics.Data.Fields.Entity-Query # Hyperlink -- name: " " -- name: "Hyperlink Fields (Files)" +- name: "Hyperlink Fields / Files" topicUid: Basics.Data.Fields.Hyperlink -- name: Hyperlink Default (single item) - topicUid: Basics.Data.Fields.Hyperlink-Default -- name: Hyperlink Library (file lists) - topicUid: Basics.Data.Fields.Hyperlink-Library + items: + - name: Hyperlink Default (single item) + topicUid: Basics.Data.Fields.Hyperlink-Default + - name: Hyperlink Library (file lists) + topicUid: Basics.Data.Fields.Hyperlink-Library # Number -- name: " " - name: "Number Fields" topicUid: Basics.Data.Fields.Number -- name: Number Default - topicUid: Basics.Data.Fields.Number-Default -- name: Number Dropdown - topicUid: Basics.Data.Fields.Number-Dropdown + items: + - name: Number Default + topicUid: Basics.Data.Fields.Number-Default + - name: Number Dropdown + topicUid: Basics.Data.Fields.Number-Dropdown # String -- name: " " -- name: "String / Text Fields" +# - name: " " +- name: "String / Text / WYSIWYG Fields" topicUid: Basics.Data.Fields.String -- name: String Default - topicUid: Basics.Data.Fields.String-Default -- name: String Dropdown - topicUid: Basics.Data.Fields.String-Dropdown -- name: String Dropdown Query - topicUid: Basics.Data.Fields.String-Dropdown-Query -- name: String WYSIWYG ✨ - topicUid: Basics.Data.Fields.String-Wysiwyg -- name: String WYSIWYG Rich ✨ - topicUid: Basics.Data.Fields.String-Wysiwyg-Rich -- name: String Font Icon Picker - topicUid: Basics.Data.Fields.String-Font-Icon-Picker -- name: String Url Path - topicUid: Basics.Data.Fields.String-Url-Path + items: + - name: String Default + topicUid: Basics.Data.Fields.String-Default + - name: String Dropdown + topicUid: Basics.Data.Fields.String-Dropdown + - name: String Dropdown Query + topicUid: Basics.Data.Fields.String-Dropdown-Query + - name: String WYSIWYG ✨ + topicUid: Basics.Data.Fields.String-Wysiwyg + - name: String WYSIWYG Rich ✨ + topicUid: Basics.Data.Fields.String-Wysiwyg-Rich + - name: String Font Icon Picker + topicUid: Basics.Data.Fields.String-Font-Icon-Picker + - name: String Url Path + topicUid: Basics.Data.Fields.String-Url-Path # Ephemeral -- name: " " +# - name: " " - name: "Ephemeral Fields (Temporary)" topicUid: Basics.Data.Fields.Ephemeral \ No newline at end of file diff --git a/2sxc Docs Generator/pages/basics/data/toc.yml b/2sxc Docs Generator/pages/basics/data/toc.yml index f46709129..20290bafb 100644 --- a/2sxc Docs Generator/pages/basics/data/toc.yml +++ b/2sxc Docs Generator/pages/basics/data/toc.yml @@ -14,11 +14,11 @@ - name: Entity Relationships topicUid: Basics.Data.Relationships.Index -- name: Multilanguage & i18n +- name: Multi-Language & i18n topicUid: Basics.Data.MultiLanguage.Index - name: "Metadata" - topicHref: metadata.md + href: metadata.md - name: " " diff --git a/2sxc Docs Generator/pages/basics/toc.yml b/2sxc Docs Generator/pages/basics/toc.yml index 81866dcc8..a1fd338fa 100644 --- a/2sxc Docs Generator/pages/basics/toc.yml +++ b/2sxc Docs Generator/pages/basics/toc.yml @@ -14,7 +14,6 @@ href: content/toc.yml # A bit more advanced / CMS -- name: " " - name: "Deeper Dive" - name: Principles and Values @@ -34,7 +33,6 @@ # Stack -- name: " " - name: "Stack Layers / Parts" - name: Browser @@ -56,7 +54,6 @@ topicUid: Basics.Query.LookUp.Index # Edit / CMS -- name: " " - name: "Editing and CMS" - name: Edit UX @@ -75,20 +72,18 @@ topicUid: Basics.Polymorphism.Index # Productivity -- name: " " - name: "Productivity" - name: Notes 📝 topicUid: Basics.Notes # Topics -- name: " " +- name: "Other Topics" - name: Mobile Apps & PWAs topicUid: Basics.MobileApps.Index # Internal stuff -- name: " " - name: Licenses & Features topicUid: Basics.LnF.Index diff --git a/2sxc Docs Generator/pages/guides/app-development/toc.yml b/2sxc Docs Generator/pages/guides/app-development/toc.yml index cba049941..8cf0a0a51 100644 --- a/2sxc Docs Generator/pages/guides/app-development/toc.yml +++ b/2sxc Docs Generator/pages/guides/app-development/toc.yml @@ -7,5 +7,5 @@ - name: WYSIWYG Guide topicUid: Guides.Wysiwyg.Index - name: Common Problems - topicUid: Guides.CommonProblems.Index + topicUid: Guides.AppDevelopment.CommonProblems.Index href: common-problems/toc.yml diff --git a/docs/api/dot-net/Custom.Data.CustomItem.html b/docs/api/dot-net/Custom.Data.CustomItem.html index a4a6dbe91..892441948 100644 --- a/docs/api/dot-net/Custom.Data.CustomItem.html +++ b/docs/api/dot-net/Custom.Data.CustomItem.html @@ -127,7 +127,7 @@

- 
[WorkInProgressApi("Still WIP v17.02")]
+    
[PublicApi]
 public class CustomItem : ITypedItem, ITyped, IEquatable<ITypedItem>
@@ -157,7 +157,10 @@

Remarks

-

It's not abstract, even if the most common case is to inherit, as there are cases where you want to use it directly.

+
    +
  • Released in v17.06
    • +
  • It's not abstract, even if the most common case is to inherit, as there are cases where you want to use it directly.
    • +
@@ -1472,7 +1475,7 @@

-

Get the GPS coordinates of a GPS field.

+

Get the GPS coordinates of a GPS field as a typed object.

@@ -1483,11 +1486,14 @@

Parameters

name string
-
+

Name of a field

+
protector NoParamOrder
-
+

see Convention: Named Parameters

+
required bool?
-
+

throw error if name doesn't exist, see Convention: Property Required Name Checks

+

Returns

@@ -1600,7 +1606,7 @@
Note
- 
public IResponsiveImage Img(string name, NoParamOrder noParamOrder, object settings, object factor, object width, string imgAlt, string imgAltFallback, string imgClass, object imgAttributes, object toolbar, object recipe)
+ 
public IResponsiveImage Img(string name, NoParamOrder noParamOrder = default, object settings = null, object factor = null, object width = null, string imgAlt = null, string imgAltFallback = null, string imgClass = null, object imgAttributes = null, object toolbar = null, object recipe = null)

Parameters

diff --git a/docs/api/dot-net/Custom.Hybrid.ApiTyped.html b/docs/api/dot-net/Custom.Hybrid.ApiTyped.html index 8f33febd8..f952ffe52 100644 --- a/docs/api/dot-net/Custom.Hybrid.ApiTyped.html +++ b/docs/api/dot-net/Custom.Hybrid.ApiTyped.html @@ -634,7 +634,7 @@

Property Value

MyModel - +

Data passed to this Razor template by a caller. @@ -819,7 +819,7 @@

Methods

Accepted() - +

Creates a .net-core like AcceptedResult object that produces an .net-core like StatusCodes.Status202Accepted response.

@@ -998,7 +998,7 @@

AsList<T>(object, NoParamOrder, bool) - +

Convert a list of Entities or TypedItems into a strongly typed list. @@ -1052,7 +1052,7 @@

AsStack(params object[]) - +

Create a typed object which will provide all the properties of the things wrapped inside it. @@ -1067,7 +1067,8 @@

Parameters

items object[]
-
+

objects to stack together

+

Returns

@@ -1086,11 +1087,59 @@

Returns

+ + +

+ AsStack<T>(params object[]) + +

+ +

Create a custom-typed object which will provide all the properties of the things wrapped inside it. +The priority is first-object first, so if multiple items have the property, the first in the list will be returned.

+
+
+ +
+ 
public T AsStack<T>(params object[] items) where T : class, ITypedItemWrapper16, ITypedItem, new()
+
+ +

Parameters

+
+
items object[]
+

objects to stack together

+
+
+ +

Returns

+
+
T
+

Item of the custom type

+
+
+ +

Type Parameters

+
+
T
+
+
+ + + + + + +

Remarks

+

New in 17.07

+
+ + + +

AsTyped(object, NoParamOrder, bool?) - +

Creates a typed object to read the original passed into this function. @@ -1135,7 +1184,7 @@

Returns

AsTypedList(object, NoParamOrder, bool?) - +

Create a list

@@ -1179,7 +1228,7 @@

Returns

As<T>(object, NoParamOrder, bool) - +

Convert an Entity or TypedItem into a strongly typed object. @@ -1233,7 +1282,7 @@

BadRequest() - +

Creates an .net-core like BadRequestResult that produces a .net-core like StatusCodes.Status400BadRequest response.

@@ -1272,7 +1321,7 @@

Remarks

Conflict() - +

Creates an .net-core like ConflictResult that produces a .net-core like StatusCodes.Status409Conflict response.

@@ -1311,7 +1360,7 @@

Remarks

Conflict(object) - +

Creates an .net-core like ConflictObjectResult that produces a .net-core like StatusCodes.Status409Conflict response.

@@ -1356,7 +1405,7 @@

File(NoParamOrder, bool?, string, string, string, object) - +

Create a File-result to stream to the client

@@ -1413,7 +1462,7 @@

Forbid() - +

Creates a .net-core like ForbidResult (.net-core like StatusCodes.Status403Forbidden by default).

@@ -1548,7 +1597,7 @@

Type Parameters

NoContent() - +

Creates a .net-core like NoContentResult object that produces an empty @@ -1588,7 +1637,7 @@

Remarks

NotFound() - +

Creates an .net-core like NotFoundResult that produces a .net-core like StatusCodes.Status404NotFound response.

@@ -1627,7 +1676,7 @@

Remarks

NotFound(object) - +

Creates an .net-core like NotFoundObjectResult that produces a .net-core like StatusCodes.Status404NotFound response.

@@ -1671,7 +1720,7 @@

Ok() - +

Creates a .net-core like OkResult object that produces an empty .net-core like StatusCodes.Status200OK response.

@@ -1710,7 +1759,7 @@

Remarks

Ok(object) - +

Creates an .net-core like OkObjectResult object that produces an .net-core like StatusCodes.Status200OK response.

@@ -1755,7 +1804,7 @@

Remark

Redirect(string) - +

Creates a .net-core like RedirectResult object that redirects (.net-core like StatusCodes.Status302Found) @@ -1801,7 +1850,7 @@

RedirectPermanent(string) - +

Creates a .net-core like RedirectResult object with .net-core like RedirectResult.Permanent set to true @@ -1901,7 +1950,7 @@

Returns

StatusCode(int) - +

Creates a .net-core like StatusCodeResult object by specifying a statusCode.

@@ -1946,7 +1995,7 @@

StatusCode(int, object) - +

Creates a .net-core like ObjectResult object by specifying a statusCode and value

@@ -1994,7 +2043,7 @@

Unauthorized() - +

Creates an .net-core like UnauthorizedResult that produces an .net-core like StatusCodes.Status401Unauthorized response.

@@ -2033,7 +2082,7 @@

Remarks

Unauthorized(object) - +

Creates an .net-core like UnauthorizedObjectResult that produces a .net-core like StatusCodes.Status401Unauthorized response.

diff --git a/docs/api/dot-net/Custom.Hybrid.CodeTyped.html b/docs/api/dot-net/Custom.Hybrid.CodeTyped.html index 1faad1fb0..4a8b56a45 100644 --- a/docs/api/dot-net/Custom.Hybrid.CodeTyped.html +++ b/docs/api/dot-net/Custom.Hybrid.CodeTyped.html @@ -410,7 +410,7 @@

Property Value

MyContext - +

This Context tells you about the environment, such as

@@ -597,7 +597,7 @@

Property Value

MyModel - +

Data passed to this Razor template by a caller. @@ -630,7 +630,7 @@

Property Value

MyPage - +

Information about the current Page (called Tab in DNN). @@ -663,7 +663,7 @@

Property Value

MyUser - +

Information about the current user. @@ -696,7 +696,7 @@

Property Value

MyView - +

View-information such as the view Name, Identity or Edition.

@@ -731,7 +731,7 @@

Remarks

UniqueKey - +

A unique, random key for the current module. @@ -922,7 +922,7 @@

AsList<T>(object, NoParamOrder, bool) - +

Convert a list of Entities or TypedItems into a strongly typed list. @@ -976,7 +976,7 @@

AsStack(params object[]) - +

Create a typed object which will provide all the properties of the things wrapped inside it. @@ -991,7 +991,8 @@

Parameters

items object[]
-
+

objects to stack together

+

Returns

@@ -1010,11 +1011,59 @@

Returns

+ + +

+ AsStack<T>(params object[]) + +

+ +

Create a custom-typed object which will provide all the properties of the things wrapped inside it. +The priority is first-object first, so if multiple items have the property, the first in the list will be returned.

+
+
+ +
+ 
public T AsStack<T>(params object[] items) where T : class, ITypedItemWrapper16, ITypedItem, new()
+
+ +

Parameters

+
+
items object[]
+

objects to stack together

+
+
+ +

Returns

+
+
T
+

Item of the custom type

+
+
+ +

Type Parameters

+
+
T
+
+
+ + + + + + +

Remarks

+

New in 17.07

+
+ + + +

AsTyped(object, NoParamOrder, bool?) - +

Creates a typed object to read the original passed into this function. @@ -1059,7 +1108,7 @@

Returns

AsTypedList(object, NoParamOrder, bool?) - +

Create a list

@@ -1103,7 +1152,7 @@

Returns

As<T>(object, NoParamOrder, bool) - +

Convert an Entity or TypedItem into a strongly typed object. diff --git a/docs/api/dot-net/Custom.Hybrid.RazorTyped-1.html b/docs/api/dot-net/Custom.Hybrid.RazorTyped-1.html index 486635184..90558bc9c 100644 --- a/docs/api/dot-net/Custom.Hybrid.RazorTyped-1.html +++ b/docs/api/dot-net/Custom.Hybrid.RazorTyped-1.html @@ -242,6 +242,9 @@

Type Parameters

+ diff --git a/docs/api/dot-net/Custom.Hybrid.RazorTyped.html b/docs/api/dot-net/Custom.Hybrid.RazorTyped.html index b2fe0a87b..cb7cf94a1 100644 --- a/docs/api/dot-net/Custom.Hybrid.RazorTyped.html +++ b/docs/api/dot-net/Custom.Hybrid.RazorTyped.html @@ -962,7 +962,7 @@

AsList<T>(object, NoParamOrder, bool) - +

Convert a list of Entities or TypedItems into a strongly typed list. @@ -1016,7 +1016,7 @@

AsStack(params object[]) - +

Create a typed object which will provide all the properties of the things wrapped inside it. @@ -1031,7 +1031,8 @@

Parameters

items object[]
-
+

objects to stack together

+

Returns

@@ -1050,11 +1051,59 @@

Returns

+ + +

+ AsStack<T>(params object[]) + +

+ +

Create a custom-typed object which will provide all the properties of the things wrapped inside it. +The priority is first-object first, so if multiple items have the property, the first in the list will be returned.

+
+
+ +
+ 
public T AsStack<T>(params object[] items) where T : class, ITypedItemWrapper16, ITypedItem, new()
+
+ +

Parameters

+
+
items object[]
+

objects to stack together

+
+
+ +

Returns

+
+
T
+

Item of the custom type

+
+
+ +

Type Parameters

+
+
T
+
+
+ + + + + + +

Remarks

+

New in 17.07

+
+ + + +

AsTyped(object, NoParamOrder, bool?) - +

Creates a typed object to read the original passed into this function. @@ -1099,7 +1148,7 @@

Returns

AsTypedList(object, NoParamOrder, bool?) - +

Create a list

@@ -1143,7 +1192,7 @@

Returns

As<T>(object, NoParamOrder, bool) - +

Convert an Entity or TypedItem into a strongly typed object. diff --git a/docs/api/dot-net/ToSic.Sxc.Data.IMetadata.html b/docs/api/dot-net/ToSic.Sxc.Data.IMetadata.html index 601ac73bb..06f2845fa 100644 --- a/docs/api/dot-net/ToSic.Sxc.Data.IMetadata.html +++ b/docs/api/dot-net/ToSic.Sxc.Data.IMetadata.html @@ -200,6 +200,9 @@

ITypedItem.Img(string, NoParamOrder, object, object, object, string, string, string, object, object, object)

+ diff --git a/docs/api/dot-net/ToSic.Sxc.Data.ITypedItem.html b/docs/api/dot-net/ToSic.Sxc.Data.ITypedItem.html index e08260e4a..6ac3cc8f5 100644 --- a/docs/api/dot-net/ToSic.Sxc.Data.ITypedItem.html +++ b/docs/api/dot-net/ToSic.Sxc.Data.ITypedItem.html @@ -915,6 +915,53 @@

+ +

+ Gps(string, NoParamOrder, bool?) + +

+ +

Get the GPS coordinates of a GPS field as a typed object.

+
+
+ +
+ 
GpsCoordinates Gps(string name, NoParamOrder protector = default, bool? required = null)
+
+ +

Parameters

+
+
name string
+

Name of a field

+
+
protector NoParamOrder
+

see Convention: Named Parameters

+
+
required bool?
+

throw error if name doesn't exist, see Convention: Property Required Name Checks

+
+
+ +

Returns

+
+
GpsCoordinates
+
+
+ + + + + + + +

Remarks

+

New in v17.03

+
+ + + +

@@ -1006,7 +1053,7 @@

Note
- 
IResponsiveImage Img(string name, NoParamOrder noParamOrder, object settings, object factor, object width, string imgAlt, string imgAltFallback, string imgClass, object imgAttributes, object toolbar, object recipe)
+ 
IResponsiveImage Img(string name, NoParamOrder noParamOrder = default, object settings = null, object factor = null, object width = null, string imgAlt = null, string imgAltFallback = null, string imgClass = null, object imgAttributes = null, object toolbar = null, object recipe = null)

Parameters

diff --git a/docs/api/dot-net/ToSic.Sxc.Data.ITypedStack.html b/docs/api/dot-net/ToSic.Sxc.Data.ITypedStack.html index db9e79e19..7e322dc15 100644 --- a/docs/api/dot-net/ToSic.Sxc.Data.ITypedStack.html +++ b/docs/api/dot-net/ToSic.Sxc.Data.ITypedStack.html @@ -113,7 +113,7 @@
Table of Contents

Interface ITypedStack - +

@@ -121,12 +121,13 @@

Assembly
ToSic.Sxc.dll

-
+

The stack as typed object.

+
[PublicApi]
-public interface ITypedStack : ITyped, ICanDebug
+public interface ITypedStack : ITypedItem, ITyped, IEquatable<ITypedItem>, ICanDebug
@@ -138,6 +139,81 @@

Inherited Members
+ + + + + + + + + + + + + + + + + + + + + + + + + @@ -186,6 +262,9 @@

ITyped.Get<TValue>(string, NoParamOrder, TValue, bool?)

+ @@ -194,112 +273,16 @@

Methods -

- - - - -

- Child(string, NoParamOrder, bool?) - -

- -
-
- -
- 
ITypedItem Child(string name, NoParamOrder noParamOrder = default, bool? required = null)
-
- -

Parameters

-
-
name string
-
-
noParamOrder NoParamOrder
-
-
required bool?
-
-
- -

Returns

-
-
ITypedItem
-
-
- - - - - - - - - - - - - -

- Children(string, NoParamOrder, string, bool?) - -

- -

A typed list of sub-items. Important for LINQ style querying or just -working with various lists. Note that for getting child items of this item you -can just use the properties, like content.Authors.
-But using Children("Authors", type: typeName) gives you the ability to restrict to a type.
-Please check the tutorials on 2sxc.org/dnn-tutorials/ for more info.

+

Remarks

+

Enhanced in v17.07 to fully support ITypedItem, before it only supported ITyped.

-
- -
- 
IEnumerable<ITypedItem> Children(string field = null, NoParamOrder noParamOrder = default, string type = null, bool? required = null)
-
- -

Parameters

-
-
field string
-

Optional field filter - would only return items that point to the current item in a specific field name.

-
-
noParamOrder NoParamOrder
-

see Convention: Named Parameters

-
-
type string
-

Optional type filter - would only return items of this type.

-
-
required bool?
-

throw error if name doesn't exist, see Convention: Property Required Name Checks

-
-
- -

Returns

-
-
IEnumerable<ITypedItem>
-

A list of all items pointing here (filtered), converted to DynamicEntity for convenience.

-
-
- - - - - - - -

Remarks

-

Note that the parameter-order is reversed to the Parents()

-
- -
- Edit this page + Edit this page
diff --git a/docs/api/dot-net/ToSic.Sxc.Data.html b/docs/api/dot-net/ToSic.Sxc.Data.html index 28473c9aa..d597e7759 100644 --- a/docs/api/dot-net/ToSic.Sxc.Data.html +++ b/docs/api/dot-net/ToSic.Sxc.Data.html @@ -187,7 +187,8 @@

ITypedStack
-
+

The stack as typed object.

+
diff --git a/docs/api/dot-net/ToSic.Sxc.Services.ILinkService.html b/docs/api/dot-net/ToSic.Sxc.Services.ILinkService.html index f826c3c89..f9fcf67b3 100644 --- a/docs/api/dot-net/ToSic.Sxc.Services.ILinkService.html +++ b/docs/api/dot-net/ToSic.Sxc.Services.ILinkService.html @@ -113,7 +113,7 @@

Table of Contents

Interface ILinkService - +

@@ -171,7 +171,7 @@

Methods

Base() - +

A base url for the current page, for use in html-base tags

@@ -228,6 +228,7 @@

Parameters

settings object
    +
  • A settings name such as "Content", "Lightbox" etc. (new 17.06)
  • A standardized Image-Settings object like Settings.Images.Content - see https://go.2sxc.org/settings
  • Or a dynamic object containing settings properties (this can also be a merged custom + standard settings)
  • Or a specially prepared IResizeSettings object containing all settings. @@ -312,7 +313,7 @@

    To(NoParamOrder, int?, string, object, string, string) - +

    returns a link to the current page with parameters resolved in a way that DNN wants it

    @@ -386,7 +387,7 @@

    - Edit this page + Edit this page

    diff --git a/docs/basics/data/fields/boolean-tristate.html b/docs/basics/data/fields/boolean-tristate.html index 4c38fa251..a9bafeef4 100644 --- a/docs/basics/data/fields/boolean-tristate.html +++ b/docs/basics/data/fields/boolean-tristate.html @@ -108,7 +108,9 @@
    Table of Contents

    Field Input-Type boolean-tristate

    -

    Use this field type for configuring simple true/false UI elements, storing boolean/boolean data. It's an extension of the basic boolean field type.

    +

    Use this field type for configuring simple true/false UI elements, +storing boolean/boolean data. +It's an extension of the basic boolean field type.

    Features

    1. provide a basic on/off input field (toggle switch)
      2. diff --git a/docs/basics/data/fields/custom-gps.html b/docs/basics/data/fields/custom-gps.html index fe2a1cbdb..2187f247a 100644 --- a/docs/basics/data/fields/custom-gps.html +++ b/docs/basics/data/fields/custom-gps.html @@ -120,7 +120,9 @@

      Configure Custom-Gps

History

    -
  1. Introduced in 2sxc 2.0
    2. +
  2. Introduced in 2sxc 2.0 - originally with a virtual field which placed the numbers into 2 number fields
    3. +
  3. Modified behavior to use a JSON field instead ca. 2sxc 7
    4. +
  4. Improved Razor with ITypedItem to have a .Gps(...) method 2sxc 17
diff --git a/docs/basics/data/fields/toc.html b/docs/basics/data/fields/toc.html index 43844c10f..728963fb9 100644 --- a/docs/basics/data/fields/toc.html +++ b/docs/basics/data/fields/toc.html @@ -16,115 +16,120 @@ General Field Settings
  • - -
    • -
  • + Boolean Fields + +
  • - Boolean Default -
    • -
  • - Boolean Tristate -
    • -
  • - -
    • -
  • + Date/Time Fields + +
  • - DateTime Default -
    • -
  • - -
    • -
  • - Custom Fields -
    • -
  • - Custom GPS -
    • -
  • - + + Custom Fields / GPS + +
  • + Empty Fields (Groups) -
    • -
  • - Empty Default (new Group) -
    • -
  • - Empty End (close a Group) -
    • -
  • - Empty Message -
    • -
  • - -
    • -
  • + + +
    • +
  • + Entity Fields (Relationships) + + +
    • +
  • + + Hyperlink Fields / Files + +
  • - Entity Default -
    • -
  • - Entity from Query -
    • -
  • - -
    • -
  • - Hyperlink Fields (Files) -
    • -
  • - Hyperlink Default (single item) -
    • -
  • - Hyperlink Library (file lists) -
    • -
  • - -
    • -
  • + Number Fields -
    • -
  • - Number Default -
    • -
  • - Number Dropdown -
    • -
  • - -
    • -
  • - String / Text Fields -
    • -
  • - String Default -
    • -
  • - String Dropdown -
    • -
  • - String Dropdown Query -
    • -
  • - String WYSIWYG ✨ -
    • -
  • - String WYSIWYG Rich ✨ -
    • -
  • - String Font Icon Picker -
    • -
  • - String Url Path -
    • -
  • - + + +
    • +
  • + + String / Text / WYSIWYG Fields + +
  • Ephemeral Fields (Temporary) diff --git a/docs/basics/data/fields/toc.json b/docs/basics/data/fields/toc.json index d083a1b34..82db200c8 100644 --- a/docs/basics/data/fields/toc.json +++ b/docs/basics/data/fields/toc.json @@ -1,2 +1,2 @@ -{"order":100,"items":[{"name":"General Field Settings","href":"all.html","topicHref":"all.html","topicUid":"Basics.Data.Fields.GeneralSettings"},{"name":" "},{"name":"Boolean Fields","href":"boolean.html","topicHref":"boolean.html","topicUid":"Basics.Data.Fields.Boolean"},{"name":"Boolean Default","href":"boolean-default.html","topicHref":"boolean-default.html","topicUid":"Basics.Data.Fields.Boolean-Default"},{"name":"Boolean Tristate","href":"boolean-tristate.html","topicHref":"boolean-tristate.html","topicUid":"Basics.Data.Fields.Boolean-Tristate"},{"name":" "},{"name":"Date/Time Fields","href":"datetime.html","topicHref":"datetime.html","topicUid":"Basics.Data.Fields.DateTime"},{"name":"DateTime Default","href":"datetime-default.html","topicHref":"datetime-default.html","topicUid":"Basics.Data.Fields.DateTime-Default"},{"name":" "},{"name":"Custom Fields","href":"custom.html","topicHref":"custom.html","topicUid":"Basics.Data.Fields.Custom"},{"name":"Custom GPS","href":"custom-gps.html","topicHref":"custom-gps.html","topicUid":"Basics.Data.Fields.CustomGps"},{"name":" "},{"name":"Empty Fields (Groups)","href":"empty.html","topicHref":"empty.html","topicUid":"Basics.Data.Fields.Empty"},{"name":"Empty Default (new Group)","href":"empty-default.html","topicHref":"empty-default.html","topicUid":"Basics.Data.Fields.Empty-Default"},{"name":"Empty End (close a Group)","href":"empty-end.html","topicHref":"empty-end.html","topicUid":"Basics.Data.Fields.Empty-End"},{"name":"Empty Message","href":"empty-message.html","topicHref":"empty-message.html","topicUid":"Basics.Data.Fields.Empty-Message"},{"name":" "},{"name":"Entity Fields (Relationships)","href":"entity.html","topicHref":"entity.html","topicUid":"Basics.Data.Fields.Entity"},{"name":"Entity Default","href":"entity-default.html","topicHref":"entity-default.html","topicUid":"Basics.Data.Fields.Entity-Default"},{"name":"Entity from Query","href":"entity-query.html","topicHref":"entity-query.html","topicUid":"Basics.Data.Fields.Entity-Query"},{"name":" "},{"name":"Hyperlink Fields (Files)","href":"hyperlink.html","topicHref":"hyperlink.html","topicUid":"Basics.Data.Fields.Hyperlink"},{"name":"Hyperlink Default (single item)","href":"hyperlink-default.html","topicHref":"hyperlink-default.html","topicUid":"Basics.Data.Fields.Hyperlink-Default"},{"name":"Hyperlink Library (file lists)","href":"hyperlink-library.html","topicHref":"hyperlink-library.html","topicUid":"Basics.Data.Fields.Hyperlink-Library"},{"name":" "},{"name":"Number Fields","href":"number.html","topicHref":"number.html","topicUid":"Basics.Data.Fields.Number"},{"name":"Number Default","href":"number-default.html","topicHref":"number-default.html","topicUid":"Basics.Data.Fields.Number-Default"},{"name":"Number Dropdown","href":"number-dropdown.html","topicHref":"number-dropdown.html","topicUid":"Basics.Data.Fields.Number-Dropdown"},{"name":" "},{"name":"String / Text Fields","href":"string.html","topicHref":"string.html","topicUid":"Basics.Data.Fields.String"},{"name":"String Default","href":"string-default.html","topicHref":"string-default.html","topicUid":"Basics.Data.Fields.String-Default"},{"name":"String Dropdown","href":"string-dropdown.html","topicHref":"string-dropdown.html","topicUid":"Basics.Data.Fields.String-Dropdown"},{"name":"String Dropdown Query","href":"string-dropdown-query.html","topicHref":"string-dropdown-query.html","topicUid":"Basics.Data.Fields.String-Dropdown-Query"},{"name":"String WYSIWYG ✨","href":"string-wysiwyg/index.html","topicHref":"string-wysiwyg/index.html","topicUid":"Basics.Data.Fields.String-Wysiwyg"},{"name":"String WYSIWYG Rich ✨","href":"string-wysiwyg/rich.html","topicHref":"string-wysiwyg/rich.html","topicUid":"Basics.Data.Fields.String-Wysiwyg-Rich"},{"name":"String Font Icon Picker","href":"string-font-icon-picker.html","topicHref":"string-font-icon-picker.html","topicUid":"Basics.Data.Fields.String-Font-Icon-Picker"},{"name":"String Url Path","href":"string-url-path.html","topicHref":"string-url-path.html","topicUid":"Basics.Data.Fields.String-Url-Path"},{"name":" "},{"name":"Ephemeral Fields (Temporary)","href":"ephemeral.html","topicHref":"ephemeral.html","topicUid":"Basics.Data.Fields.Ephemeral"}]} +{"order":100,"items":[{"name":"General Field Settings","href":"all.html","topicHref":"all.html","topicUid":"Basics.Data.Fields.GeneralSettings"},{"name":"Boolean Fields","href":"boolean.html","topicHref":"boolean.html","topicUid":"Basics.Data.Fields.Boolean","items":[{"name":"Boolean Default","href":"boolean-default.html","topicHref":"boolean-default.html","topicUid":"Basics.Data.Fields.Boolean-Default"},{"name":"Boolean Tristate","href":"boolean-tristate.html","topicHref":"boolean-tristate.html","topicUid":"Basics.Data.Fields.Boolean-Tristate"}]},{"name":"Date/Time Fields","href":"datetime.html","topicHref":"datetime.html","topicUid":"Basics.Data.Fields.DateTime","items":[{"name":"DateTime Default","href":"datetime-default.html","topicHref":"datetime-default.html","topicUid":"Basics.Data.Fields.DateTime-Default"}]},{"name":"Custom Fields / GPS","href":"custom.html","topicHref":"custom.html","topicUid":"Basics.Data.Fields.Custom","items":[{"name":"Custom GPS","href":"custom-gps.html","topicHref":"custom-gps.html","topicUid":"Basics.Data.Fields.CustomGps"}]},{"name":"Empty Fields (Groups)","href":"empty.html","topicHref":"empty.html","topicUid":"Basics.Data.Fields.Empty","items":[{"name":"Empty Default (new Group)","href":"empty-default.html","topicHref":"empty-default.html","topicUid":"Basics.Data.Fields.Empty-Default"},{"name":"Empty End (close a Group)","href":"empty-end.html","topicHref":"empty-end.html","topicUid":"Basics.Data.Fields.Empty-End"},{"name":"Empty Message","href":"empty-message.html","topicHref":"empty-message.html","topicUid":"Basics.Data.Fields.Empty-Message"}]},{"name":"Entity Fields (Relationships)","href":"entity.html","topicHref":"entity.html","topicUid":"Basics.Data.Fields.Entity","items":[{"name":"Entity Default","href":"entity-default.html","topicHref":"entity-default.html","topicUid":"Basics.Data.Fields.Entity-Default"},{"name":"Entity from Query","href":"entity-query.html","topicHref":"entity-query.html","topicUid":"Basics.Data.Fields.Entity-Query"}]},{"name":"Hyperlink Fields / Files","href":"hyperlink.html","topicHref":"hyperlink.html","topicUid":"Basics.Data.Fields.Hyperlink","items":[{"name":"Hyperlink Default (single item)","href":"hyperlink-default.html","topicHref":"hyperlink-default.html","topicUid":"Basics.Data.Fields.Hyperlink-Default"},{"name":"Hyperlink Library (file lists)","href":"hyperlink-library.html","topicHref":"hyperlink-library.html","topicUid":"Basics.Data.Fields.Hyperlink-Library"}]},{"name":"Number Fields","href":"number.html","topicHref":"number.html","topicUid":"Basics.Data.Fields.Number","items":[{"name":"Number Default","href":"number-default.html","topicHref":"number-default.html","topicUid":"Basics.Data.Fields.Number-Default"},{"name":"Number Dropdown","href":"number-dropdown.html","topicHref":"number-dropdown.html","topicUid":"Basics.Data.Fields.Number-Dropdown"}]},{"name":"String / Text / WYSIWYG Fields","href":"string.html","topicHref":"string.html","topicUid":"Basics.Data.Fields.String","items":[{"name":"String Default","href":"string-default.html","topicHref":"string-default.html","topicUid":"Basics.Data.Fields.String-Default"},{"name":"String Dropdown","href":"string-dropdown.html","topicHref":"string-dropdown.html","topicUid":"Basics.Data.Fields.String-Dropdown"},{"name":"String Dropdown Query","href":"string-dropdown-query.html","topicHref":"string-dropdown-query.html","topicUid":"Basics.Data.Fields.String-Dropdown-Query"},{"name":"String WYSIWYG ✨","href":"string-wysiwyg/index.html","topicHref":"string-wysiwyg/index.html","topicUid":"Basics.Data.Fields.String-Wysiwyg"},{"name":"String WYSIWYG Rich ✨","href":"string-wysiwyg/rich.html","topicHref":"string-wysiwyg/rich.html","topicUid":"Basics.Data.Fields.String-Wysiwyg-Rich"},{"name":"String Font Icon Picker","href":"string-font-icon-picker.html","topicHref":"string-font-icon-picker.html","topicUid":"Basics.Data.Fields.String-Font-Icon-Picker"},{"name":"String Url Path","href":"string-url-path.html","topicHref":"string-url-path.html","topicUid":"Basics.Data.Fields.String-Url-Path"}]},{"name":"Ephemeral Fields (Temporary)","href":"ephemeral.html","topicHref":"ephemeral.html","topicUid":"Basics.Data.Fields.Ephemeral"}]} diff --git a/docs/basics/data/toc.html b/docs/basics/data/toc.html index faef8de73..04c543525 100644 --- a/docs/basics/data/toc.html +++ b/docs/basics/data/toc.html @@ -62,115 +62,120 @@ General Field Settings
  • - -
    • -
  • + Boolean Fields + +
  • - Boolean Default -
    • -
  • - Boolean Tristate -
    • -
  • - -
    • -
  • + Date/Time Fields + +
  • - DateTime Default -
    • -
  • - -
    • -
  • - Custom Fields -
    • -
  • - Custom GPS -
    • -
  • - + + Custom Fields / GPS + +
  • + Empty Fields (Groups) + +
  • - Empty Default (new Group) -
    • -
  • - Empty End (close a Group) -
    • -
  • - Empty Message -
    • -
  • - -
    • -
  • + Entity Fields (Relationships) + +
  • - Entity Default -
    • -
  • - Entity from Query -
    • -
  • - -
    • -
  • - Hyperlink Fields (Files) -
    • -
  • - Hyperlink Default (single item) -
    • -
  • - Hyperlink Library (file lists) -
    • -
  • - + + Hyperlink Fields / Files + +
  • + Number Fields + +
  • - Number Default -
    • -
  • - Number Dropdown -
    • -
  • - -
    • -
  • - String / Text Fields -
    • -
  • - String Default -
    • -
  • - String Dropdown -
    • -
  • - String Dropdown Query -
    • -
  • - String WYSIWYG ✨ -
    • -
  • - String WYSIWYG Rich ✨ -
    • -
  • - String Font Icon Picker -
    • -
  • - String Url Path -
    • -
  • - + + String / Text / WYSIWYG Fields + +
  • Ephemeral Fields (Temporary) @@ -198,7 +203,7 @@ Entity Relationships
  • - Multilanguage & i18n + Multi-Language & i18n
  • Metadata diff --git a/docs/basics/data/toc.json b/docs/basics/data/toc.json index 88d77d0cb..19086f903 100644 --- a/docs/basics/data/toc.json +++ b/docs/basics/data/toc.json @@ -1,2 +1,2 @@ -{"order":100,"items":[{"name":"Content-Types","href":"content-types/index.html","topicHref":"content-types/index.html","includedFrom":"~/pages/basics/data/content-types/toc.yml","topicUid":"Basics.Data.ContentTypes.Index","items":[{"name":"App Content-Types","href":"content-types/range-app.html","topicHref":"content-types/range-app.html","topicUid":"Basics.Data.ContentTypes.App"},{"name":"App Shared Content-Types","href":"content-types/range-app-shared.html","topicHref":"content-types/range-app-shared.html","topicUid":"Basics.Data.ContentTypes.Shared"},{"name":"System Content-Types","href":"content-types/range-global-system.html","topicHref":"content-types/range-global-system.html","topicUid":"Basics.Data.ContentTypes.System"},{"name":"Global Content-Types","href":"content-types/range-global.html","topicHref":"content-types/range-global.html","topicUid":"Basics.Data.ContentTypes.Global"},{"name":"Content-Type Scopes","href":"content-types/scopes.html","topicHref":"content-types/scopes.html","topicUid":"Basics.Data.Scopes"},{"name":"Content-Type Names","href":"content-types/names.html","topicHref":"content-types/names.html","topicUid":"Basics.Data.ContentTypes.Names"},{"name":"Technical Specs","href":"content-types/specs/index.html","topicHref":"content-types/specs/index.html","topicUid":"Basics.Data.ContentTypes.Technical.Index","items":[{"name":"SQL Storage","href":"content-types/specs/sql-storage.html","topicHref":"content-types/specs/sql-storage.html","topicUid":"Basics.Data.ContentTypes.SqlStorage"},{"name":"File Storage","href":"content-types/specs/file-storage.html","topicHref":"content-types/specs/file-storage.html","topicUid":"Basics.Data.ContentTypes.FileStorage"},{"name":"C# Object Structure","href":"content-types/specs/object-structure.html","topicHref":"content-types/specs/object-structure.html","topicUid":"Basics.Data.ContentTypes.ObjectStructure"}]}]},{"name":"Fields / Attributes","href":"fields/index.html","topicHref":"fields/index.html","includedFrom":"~/pages/basics/data/fields/toc.yml","topicUid":"Basics.Data.Fields.Index","items":[{"name":"General Field Settings","href":"fields/all.html","topicHref":"fields/all.html","topicUid":"Basics.Data.Fields.GeneralSettings"},{"name":" "},{"name":"Boolean Fields","href":"fields/boolean.html","topicHref":"fields/boolean.html","topicUid":"Basics.Data.Fields.Boolean"},{"name":"Boolean Default","href":"fields/boolean-default.html","topicHref":"fields/boolean-default.html","topicUid":"Basics.Data.Fields.Boolean-Default"},{"name":"Boolean Tristate","href":"fields/boolean-tristate.html","topicHref":"fields/boolean-tristate.html","topicUid":"Basics.Data.Fields.Boolean-Tristate"},{"name":" "},{"name":"Date/Time Fields","href":"fields/datetime.html","topicHref":"fields/datetime.html","topicUid":"Basics.Data.Fields.DateTime"},{"name":"DateTime Default","href":"fields/datetime-default.html","topicHref":"fields/datetime-default.html","topicUid":"Basics.Data.Fields.DateTime-Default"},{"name":" "},{"name":"Custom Fields","href":"fields/custom.html","topicHref":"fields/custom.html","topicUid":"Basics.Data.Fields.Custom"},{"name":"Custom GPS","href":"fields/custom-gps.html","topicHref":"fields/custom-gps.html","topicUid":"Basics.Data.Fields.CustomGps"},{"name":" "},{"name":"Empty Fields (Groups)","href":"fields/empty.html","topicHref":"fields/empty.html","topicUid":"Basics.Data.Fields.Empty"},{"name":"Empty Default (new Group)","href":"fields/empty-default.html","topicHref":"fields/empty-default.html","topicUid":"Basics.Data.Fields.Empty-Default"},{"name":"Empty End (close a Group)","href":"fields/empty-end.html","topicHref":"fields/empty-end.html","topicUid":"Basics.Data.Fields.Empty-End"},{"name":"Empty Message","href":"fields/empty-message.html","topicHref":"fields/empty-message.html","topicUid":"Basics.Data.Fields.Empty-Message"},{"name":" "},{"name":"Entity Fields (Relationships)","href":"fields/entity.html","topicHref":"fields/entity.html","topicUid":"Basics.Data.Fields.Entity"},{"name":"Entity Default","href":"fields/entity-default.html","topicHref":"fields/entity-default.html","topicUid":"Basics.Data.Fields.Entity-Default"},{"name":"Entity from Query","href":"fields/entity-query.html","topicHref":"fields/entity-query.html","topicUid":"Basics.Data.Fields.Entity-Query"},{"name":" "},{"name":"Hyperlink Fields (Files)","href":"fields/hyperlink.html","topicHref":"fields/hyperlink.html","topicUid":"Basics.Data.Fields.Hyperlink"},{"name":"Hyperlink Default (single item)","href":"fields/hyperlink-default.html","topicHref":"fields/hyperlink-default.html","topicUid":"Basics.Data.Fields.Hyperlink-Default"},{"name":"Hyperlink Library (file lists)","href":"fields/hyperlink-library.html","topicHref":"fields/hyperlink-library.html","topicUid":"Basics.Data.Fields.Hyperlink-Library"},{"name":" "},{"name":"Number Fields","href":"fields/number.html","topicHref":"fields/number.html","topicUid":"Basics.Data.Fields.Number"},{"name":"Number Default","href":"fields/number-default.html","topicHref":"fields/number-default.html","topicUid":"Basics.Data.Fields.Number-Default"},{"name":"Number Dropdown","href":"fields/number-dropdown.html","topicHref":"fields/number-dropdown.html","topicUid":"Basics.Data.Fields.Number-Dropdown"},{"name":" "},{"name":"String / Text Fields","href":"fields/string.html","topicHref":"fields/string.html","topicUid":"Basics.Data.Fields.String"},{"name":"String Default","href":"fields/string-default.html","topicHref":"fields/string-default.html","topicUid":"Basics.Data.Fields.String-Default"},{"name":"String Dropdown","href":"fields/string-dropdown.html","topicHref":"fields/string-dropdown.html","topicUid":"Basics.Data.Fields.String-Dropdown"},{"name":"String Dropdown Query","href":"fields/string-dropdown-query.html","topicHref":"fields/string-dropdown-query.html","topicUid":"Basics.Data.Fields.String-Dropdown-Query"},{"name":"String WYSIWYG ✨","href":"fields/string-wysiwyg/index.html","topicHref":"fields/string-wysiwyg/index.html","topicUid":"Basics.Data.Fields.String-Wysiwyg"},{"name":"String WYSIWYG Rich ✨","href":"fields/string-wysiwyg/rich.html","topicHref":"fields/string-wysiwyg/rich.html","topicUid":"Basics.Data.Fields.String-Wysiwyg-Rich"},{"name":"String Font Icon Picker","href":"fields/string-font-icon-picker.html","topicHref":"fields/string-font-icon-picker.html","topicUid":"Basics.Data.Fields.String-Font-Icon-Picker"},{"name":"String Url Path","href":"fields/string-url-path.html","topicHref":"fields/string-url-path.html","topicUid":"Basics.Data.Fields.String-Url-Path"},{"name":" "},{"name":"Ephemeral Fields (Temporary)","href":"fields/ephemeral.html","topicHref":"fields/ephemeral.html","topicUid":"Basics.Data.Fields.Ephemeral"}]},{"name":"Entities / Data","href":"entities/index.html","topicHref":"entities/index.html","includedFrom":"~/pages/basics/data/entities/toc.yml","topicUid":"Basics.Data.Entities.Index","items":[{"name":"Technical Specs","items":[{"name":"C# Object Structure","href":"entities/specs/object-structure.html","topicHref":"entities/specs/object-structure.html","topicUid":"Basics.Data.Entities.ObjectStructure"}]}]},{"name":"Entity Relationships","href":"relationships/index.html","topicHref":"relationships/index.html","topicUid":"Basics.Data.Relationships.Index"},{"name":"Multilanguage & i18n","href":"multi-language/index.html","topicHref":"multi-language/index.html","topicUid":"Basics.Data.MultiLanguage.Index"},{"name":"Metadata","topicHref":"metadata.html","homepage":"metadata.html"},{"name":" "},{"name":"Data Export / Import","href":"export-import/index.html","topicHref":"export-import/index.html","topicUid":"Basics.Data.ExportImport.Index"},{"name":"Instance Data vs. All Data","href":"instance/index.html","topicHref":"instance/index.html","topicUid":"Basics.Data.Instance.Index"},{"name":"How data flows","href":"how-data-flows.html","topicHref":"how-data-flows.html"}]} +{"order":100,"items":[{"name":"Content-Types","href":"content-types/index.html","topicHref":"content-types/index.html","includedFrom":"~/pages/basics/data/content-types/toc.yml","topicUid":"Basics.Data.ContentTypes.Index","items":[{"name":"App Content-Types","href":"content-types/range-app.html","topicHref":"content-types/range-app.html","topicUid":"Basics.Data.ContentTypes.App"},{"name":"App Shared Content-Types","href":"content-types/range-app-shared.html","topicHref":"content-types/range-app-shared.html","topicUid":"Basics.Data.ContentTypes.Shared"},{"name":"System Content-Types","href":"content-types/range-global-system.html","topicHref":"content-types/range-global-system.html","topicUid":"Basics.Data.ContentTypes.System"},{"name":"Global Content-Types","href":"content-types/range-global.html","topicHref":"content-types/range-global.html","topicUid":"Basics.Data.ContentTypes.Global"},{"name":"Content-Type Scopes","href":"content-types/scopes.html","topicHref":"content-types/scopes.html","topicUid":"Basics.Data.Scopes"},{"name":"Content-Type Names","href":"content-types/names.html","topicHref":"content-types/names.html","topicUid":"Basics.Data.ContentTypes.Names"},{"name":"Technical Specs","href":"content-types/specs/index.html","topicHref":"content-types/specs/index.html","topicUid":"Basics.Data.ContentTypes.Technical.Index","items":[{"name":"SQL Storage","href":"content-types/specs/sql-storage.html","topicHref":"content-types/specs/sql-storage.html","topicUid":"Basics.Data.ContentTypes.SqlStorage"},{"name":"File Storage","href":"content-types/specs/file-storage.html","topicHref":"content-types/specs/file-storage.html","topicUid":"Basics.Data.ContentTypes.FileStorage"},{"name":"C# Object Structure","href":"content-types/specs/object-structure.html","topicHref":"content-types/specs/object-structure.html","topicUid":"Basics.Data.ContentTypes.ObjectStructure"}]}]},{"name":"Fields / Attributes","href":"fields/index.html","topicHref":"fields/index.html","includedFrom":"~/pages/basics/data/fields/toc.yml","topicUid":"Basics.Data.Fields.Index","items":[{"name":"General Field Settings","href":"fields/all.html","topicHref":"fields/all.html","topicUid":"Basics.Data.Fields.GeneralSettings"},{"name":"Boolean Fields","href":"fields/boolean.html","topicHref":"fields/boolean.html","topicUid":"Basics.Data.Fields.Boolean","items":[{"name":"Boolean Default","href":"fields/boolean-default.html","topicHref":"fields/boolean-default.html","topicUid":"Basics.Data.Fields.Boolean-Default"},{"name":"Boolean Tristate","href":"fields/boolean-tristate.html","topicHref":"fields/boolean-tristate.html","topicUid":"Basics.Data.Fields.Boolean-Tristate"}]},{"name":"Date/Time Fields","href":"fields/datetime.html","topicHref":"fields/datetime.html","topicUid":"Basics.Data.Fields.DateTime","items":[{"name":"DateTime Default","href":"fields/datetime-default.html","topicHref":"fields/datetime-default.html","topicUid":"Basics.Data.Fields.DateTime-Default"}]},{"name":"Custom Fields / GPS","href":"fields/custom.html","topicHref":"fields/custom.html","topicUid":"Basics.Data.Fields.Custom","items":[{"name":"Custom GPS","href":"fields/custom-gps.html","topicHref":"fields/custom-gps.html","topicUid":"Basics.Data.Fields.CustomGps"}]},{"name":"Empty Fields (Groups)","href":"fields/empty.html","topicHref":"fields/empty.html","topicUid":"Basics.Data.Fields.Empty","items":[{"name":"Empty Default (new Group)","href":"fields/empty-default.html","topicHref":"fields/empty-default.html","topicUid":"Basics.Data.Fields.Empty-Default"},{"name":"Empty End (close a Group)","href":"fields/empty-end.html","topicHref":"fields/empty-end.html","topicUid":"Basics.Data.Fields.Empty-End"},{"name":"Empty Message","href":"fields/empty-message.html","topicHref":"fields/empty-message.html","topicUid":"Basics.Data.Fields.Empty-Message"}]},{"name":"Entity Fields (Relationships)","href":"fields/entity.html","topicHref":"fields/entity.html","topicUid":"Basics.Data.Fields.Entity","items":[{"name":"Entity Default","href":"fields/entity-default.html","topicHref":"fields/entity-default.html","topicUid":"Basics.Data.Fields.Entity-Default"},{"name":"Entity from Query","href":"fields/entity-query.html","topicHref":"fields/entity-query.html","topicUid":"Basics.Data.Fields.Entity-Query"}]},{"name":"Hyperlink Fields / Files","href":"fields/hyperlink.html","topicHref":"fields/hyperlink.html","topicUid":"Basics.Data.Fields.Hyperlink","items":[{"name":"Hyperlink Default (single item)","href":"fields/hyperlink-default.html","topicHref":"fields/hyperlink-default.html","topicUid":"Basics.Data.Fields.Hyperlink-Default"},{"name":"Hyperlink Library (file lists)","href":"fields/hyperlink-library.html","topicHref":"fields/hyperlink-library.html","topicUid":"Basics.Data.Fields.Hyperlink-Library"}]},{"name":"Number Fields","href":"fields/number.html","topicHref":"fields/number.html","topicUid":"Basics.Data.Fields.Number","items":[{"name":"Number Default","href":"fields/number-default.html","topicHref":"fields/number-default.html","topicUid":"Basics.Data.Fields.Number-Default"},{"name":"Number Dropdown","href":"fields/number-dropdown.html","topicHref":"fields/number-dropdown.html","topicUid":"Basics.Data.Fields.Number-Dropdown"}]},{"name":"String / Text / WYSIWYG Fields","href":"fields/string.html","topicHref":"fields/string.html","topicUid":"Basics.Data.Fields.String","items":[{"name":"String Default","href":"fields/string-default.html","topicHref":"fields/string-default.html","topicUid":"Basics.Data.Fields.String-Default"},{"name":"String Dropdown","href":"fields/string-dropdown.html","topicHref":"fields/string-dropdown.html","topicUid":"Basics.Data.Fields.String-Dropdown"},{"name":"String Dropdown Query","href":"fields/string-dropdown-query.html","topicHref":"fields/string-dropdown-query.html","topicUid":"Basics.Data.Fields.String-Dropdown-Query"},{"name":"String WYSIWYG ✨","href":"fields/string-wysiwyg/index.html","topicHref":"fields/string-wysiwyg/index.html","topicUid":"Basics.Data.Fields.String-Wysiwyg"},{"name":"String WYSIWYG Rich ✨","href":"fields/string-wysiwyg/rich.html","topicHref":"fields/string-wysiwyg/rich.html","topicUid":"Basics.Data.Fields.String-Wysiwyg-Rich"},{"name":"String Font Icon Picker","href":"fields/string-font-icon-picker.html","topicHref":"fields/string-font-icon-picker.html","topicUid":"Basics.Data.Fields.String-Font-Icon-Picker"},{"name":"String Url Path","href":"fields/string-url-path.html","topicHref":"fields/string-url-path.html","topicUid":"Basics.Data.Fields.String-Url-Path"}]},{"name":"Ephemeral Fields (Temporary)","href":"fields/ephemeral.html","topicHref":"fields/ephemeral.html","topicUid":"Basics.Data.Fields.Ephemeral"}]},{"name":"Entities / Data","href":"entities/index.html","topicHref":"entities/index.html","includedFrom":"~/pages/basics/data/entities/toc.yml","topicUid":"Basics.Data.Entities.Index","items":[{"name":"Technical Specs","items":[{"name":"C# Object Structure","href":"entities/specs/object-structure.html","topicHref":"entities/specs/object-structure.html","topicUid":"Basics.Data.Entities.ObjectStructure"}]}]},{"name":"Entity Relationships","href":"relationships/index.html","topicHref":"relationships/index.html","topicUid":"Basics.Data.Relationships.Index"},{"name":"Multi-Language & i18n","href":"multi-language/index.html","topicHref":"multi-language/index.html","topicUid":"Basics.Data.MultiLanguage.Index"},{"name":"Metadata","href":"metadata.html","topicHref":"metadata.html"},{"name":" "},{"name":"Data Export / Import","href":"export-import/index.html","topicHref":"export-import/index.html","topicUid":"Basics.Data.ExportImport.Index"},{"name":"Instance Data vs. All Data","href":"instance/index.html","topicHref":"instance/index.html","topicUid":"Basics.Data.Instance.Index"},{"name":"How data flows","href":"how-data-flows.html","topicHref":"how-data-flows.html"}]} diff --git a/docs/basics/toc.html b/docs/basics/toc.html index 99a4ffc4c..c7934a709 100644 --- a/docs/basics/toc.html +++ b/docs/basics/toc.html @@ -172,115 +172,120 @@ General Field Settings
  • - -
    • -
  • + Boolean Fields + +
  • - Boolean Default -
    • -
  • - Boolean Tristate -
    • -
  • - -
    • -
  • + Date/Time Fields + +
  • - DateTime Default -
    • -
  • - -
    • -
  • - Custom Fields -
    • -
  • - Custom GPS -
    • -
  • - + + Custom Fields / GPS + +
  • + Empty Fields (Groups) + +
  • - Empty Default (new Group) -
    • -
  • - Empty End (close a Group) -
    • -
  • - Empty Message -
    • -
  • - -
    • -
  • + Entity Fields (Relationships) + +
  • - Entity Default -
    • -
  • - Entity from Query -
    • -
  • - -
    • -
  • - Hyperlink Fields (Files) -
    • -
  • - Hyperlink Default (single item) -
    • -
  • - Hyperlink Library (file lists) -
    • -
  • - + + Hyperlink Fields / Files + +
  • + Number Fields + +
  • - Number Default -
    • -
  • - Number Dropdown -
    • -
  • - -
    • -
  • - String / Text Fields -
    • -
  • - String Default -
    • -
  • - String Dropdown -
    • -
  • - String Dropdown Query -
    • -
  • - String WYSIWYG ✨ -
    • -
  • - String WYSIWYG Rich ✨ -
    • -
  • - String Font Icon Picker -
    • -
  • - String Url Path -
    • -
  • - + + String / Text / WYSIWYG Fields + +
  • Ephemeral Fields (Temporary) @@ -308,7 +313,7 @@ Entity Relationships
  • - Multilanguage & i18n + Multi-Language & i18n
  • Metadata @@ -346,9 +351,6 @@
    • -
  • - -
  • Deeper Dive
    • @@ -416,9 +418,6 @@ -
  • - -
  • Stack Layers / Parts
    • @@ -556,9 +555,6 @@
  • LookUp Token System
    • -
  • - -
  • Editing and CMS
    • @@ -705,9 +701,6 @@
  • Polymorphism
    • -
  • - -
  • Productivity
    • @@ -715,14 +708,11 @@ Notes 📝
  • - + Other Topics
  • Mobile Apps & PWAs
    • -
  • - -
  • Licenses & Features diff --git a/docs/basics/toc.json b/docs/basics/toc.json index 0ae58eeea..4e3602def 100644 --- a/docs/basics/toc.json +++ b/docs/basics/toc.json @@ -1,2 +1,2 @@ -{"items":[{"name":"Basics Overview","href":"index.html","topicHref":"index.html"},{"name":"App","href":"app/index.html","topicHref":"app/index.html","includedFrom":"~/pages/basics/app/toc.yml","topicUid":"Basics.App.Index","items":[{"name":"Folders, Files & Icons","href":"app/folders-and-files/index.html","topicHref":"app/folders-and-files/index.html","includedFrom":"~/pages/basics/app/folders-and-files/toc.yml","topicUid":"Basics.App.FoldersAndFiles.Index","items":[{"name":"App Folder","href":"app/folders-and-files/index.html","topicHref":"app/folders-and-files/index.html","topicUid":"Basics.App.FoldersAndFiles.Index"},{"name":"App_Data Folder","href":"app/folders-and-files/folder-app-data.html","topicHref":"app/folders-and-files/folder-app-data.html","topicUid":"Basics.App.FoldersAndFiles.FolderAppData"},{"name":"app.json Configuration File","href":"app/folders-and-files/app-json.html","topicHref":"app/folders-and-files/app-json.html","topicUid":"Basics.App.FoldersAndFiles.AppJson"},{"name":"App Assets (JS, Logos, …)","href":"app/folders-and-files/assets.html","topicHref":"app/folders-and-files/assets.html","topicUid":"Basics.App.FoldersAndFiles.Assets"},{"name":"Icons","href":"app/folders-and-files/icons.html","topicHref":"app/folders-and-files/icons.html","topicUid":"Basics.App.FoldersAndFiles.Icons"}]},{"name":"Views","href":"app/views/index.html","topicHref":"app/views/index.html","topicUid":"Basics.App.Views.Index","items":[{"name":"View Configuration","href":"app/views/configuration.html","topicHref":"app/views/configuration.html","topicUid":"Basics.App.Views.Configuration"},{"name":"View Settings","href":"app/views/settings.html","topicHref":"app/views/settings.html","topicUid":"Basics.App.Views.Settings"},{"name":"View Resources","href":"app/views/resources.html","topicHref":"app/views/resources.html","topicUid":"Basics.App.Views.Resources"},{"name":"View Templates","href":"app/templates.html","topicHref":"app/templates.html","topicUid":"Basics.App.Templates"}]},{"name":"WebAPIs","href":"app/web-api.html","topicHref":"app/web-api.html"},{"name":"Special Apps","items":[{"name":"The Content App","href":"app/content-app/index.html","topicHref":"app/content-app/index.html","topicUid":"Basics.App.ContentApp.Index"},{"name":"The Primary App","href":"app/primary-app/index.html","topicHref":"app/primary-app/index.html","topicUid":"Basics.App.PrimaryApp.Index"},{"name":"Inherit Apps on many Sites","href":"app/inherit/index.html","topicHref":"app/inherit/index.html","topicUid":"Basics.App.InheritApps.Index"}]},{"name":"Config, Settings & Permissions","items":[{"name":"App Configuration","href":"app/configuration.html","topicHref":"app/configuration.html","topicUid":"Basics.App.Configuration"},{"name":"App Settings","href":"app/settings.html","topicHref":"app/settings.html","topicUid":"Basics.App.Settings"},{"name":"App Resources","href":"app/resources.html","topicHref":"app/resources.html","topicUid":"Basics.App.Resources"},{"name":"App Permissions","href":"app/permissions.html","topicHref":"app/permissions.html","topicUid":"Basics.App.Permissions"}]},{"name":"Export, Import & Git","items":[{"name":"App Export & Import","href":"app/export-import/index.html","topicHref":"app/export-import/index.html","topicUid":"Basics.App.ExportImport.Index"},{"name":"Configure Export w/app.json","href":"app/export-import/app-json.html","topicHref":"app/export-import/app-json.html","topicUid":"Basics.App.ExportImport.App.Json"},{"name":"App Git Integration","href":"app/git/index.html","topicHref":"app/git/index.html","topicUid":"Basics.App.Git.Index"}]}]},{"name":"Data","href":"data/index.html","topicHref":"data/index.html","includedFrom":"~/pages/basics/data/toc.yml","topicUid":"Basics.Data.Index","items":[{"name":"Content-Types","href":"data/content-types/index.html","topicHref":"data/content-types/index.html","includedFrom":"~/pages/basics/data/content-types/toc.yml","topicUid":"Basics.Data.ContentTypes.Index","items":[{"name":"App Content-Types","href":"data/content-types/range-app.html","topicHref":"data/content-types/range-app.html","topicUid":"Basics.Data.ContentTypes.App"},{"name":"App Shared Content-Types","href":"data/content-types/range-app-shared.html","topicHref":"data/content-types/range-app-shared.html","topicUid":"Basics.Data.ContentTypes.Shared"},{"name":"System Content-Types","href":"data/content-types/range-global-system.html","topicHref":"data/content-types/range-global-system.html","topicUid":"Basics.Data.ContentTypes.System"},{"name":"Global Content-Types","href":"data/content-types/range-global.html","topicHref":"data/content-types/range-global.html","topicUid":"Basics.Data.ContentTypes.Global"},{"name":"Content-Type Scopes","href":"data/content-types/scopes.html","topicHref":"data/content-types/scopes.html","topicUid":"Basics.Data.Scopes"},{"name":"Content-Type Names","href":"data/content-types/names.html","topicHref":"data/content-types/names.html","topicUid":"Basics.Data.ContentTypes.Names"},{"name":"Technical Specs","href":"data/content-types/specs/index.html","topicHref":"data/content-types/specs/index.html","topicUid":"Basics.Data.ContentTypes.Technical.Index","items":[{"name":"SQL Storage","href":"data/content-types/specs/sql-storage.html","topicHref":"data/content-types/specs/sql-storage.html","topicUid":"Basics.Data.ContentTypes.SqlStorage"},{"name":"File Storage","href":"data/content-types/specs/file-storage.html","topicHref":"data/content-types/specs/file-storage.html","topicUid":"Basics.Data.ContentTypes.FileStorage"},{"name":"C# Object Structure","href":"data/content-types/specs/object-structure.html","topicHref":"data/content-types/specs/object-structure.html","topicUid":"Basics.Data.ContentTypes.ObjectStructure"}]}]},{"name":"Fields / Attributes","href":"data/fields/index.html","topicHref":"data/fields/index.html","includedFrom":"~/pages/basics/data/fields/toc.yml","topicUid":"Basics.Data.Fields.Index","items":[{"name":"General Field Settings","href":"data/fields/all.html","topicHref":"data/fields/all.html","topicUid":"Basics.Data.Fields.GeneralSettings"},{"name":" "},{"name":"Boolean Fields","href":"data/fields/boolean.html","topicHref":"data/fields/boolean.html","topicUid":"Basics.Data.Fields.Boolean"},{"name":"Boolean Default","href":"data/fields/boolean-default.html","topicHref":"data/fields/boolean-default.html","topicUid":"Basics.Data.Fields.Boolean-Default"},{"name":"Boolean Tristate","href":"data/fields/boolean-tristate.html","topicHref":"data/fields/boolean-tristate.html","topicUid":"Basics.Data.Fields.Boolean-Tristate"},{"name":" "},{"name":"Date/Time Fields","href":"data/fields/datetime.html","topicHref":"data/fields/datetime.html","topicUid":"Basics.Data.Fields.DateTime"},{"name":"DateTime Default","href":"data/fields/datetime-default.html","topicHref":"data/fields/datetime-default.html","topicUid":"Basics.Data.Fields.DateTime-Default"},{"name":" "},{"name":"Custom Fields","href":"data/fields/custom.html","topicHref":"data/fields/custom.html","topicUid":"Basics.Data.Fields.Custom"},{"name":"Custom GPS","href":"data/fields/custom-gps.html","topicHref":"data/fields/custom-gps.html","topicUid":"Basics.Data.Fields.CustomGps"},{"name":" "},{"name":"Empty Fields (Groups)","href":"data/fields/empty.html","topicHref":"data/fields/empty.html","topicUid":"Basics.Data.Fields.Empty"},{"name":"Empty Default (new Group)","href":"data/fields/empty-default.html","topicHref":"data/fields/empty-default.html","topicUid":"Basics.Data.Fields.Empty-Default"},{"name":"Empty End (close a Group)","href":"data/fields/empty-end.html","topicHref":"data/fields/empty-end.html","topicUid":"Basics.Data.Fields.Empty-End"},{"name":"Empty Message","href":"data/fields/empty-message.html","topicHref":"data/fields/empty-message.html","topicUid":"Basics.Data.Fields.Empty-Message"},{"name":" "},{"name":"Entity Fields (Relationships)","href":"data/fields/entity.html","topicHref":"data/fields/entity.html","topicUid":"Basics.Data.Fields.Entity"},{"name":"Entity Default","href":"data/fields/entity-default.html","topicHref":"data/fields/entity-default.html","topicUid":"Basics.Data.Fields.Entity-Default"},{"name":"Entity from Query","href":"data/fields/entity-query.html","topicHref":"data/fields/entity-query.html","topicUid":"Basics.Data.Fields.Entity-Query"},{"name":" "},{"name":"Hyperlink Fields (Files)","href":"data/fields/hyperlink.html","topicHref":"data/fields/hyperlink.html","topicUid":"Basics.Data.Fields.Hyperlink"},{"name":"Hyperlink Default (single item)","href":"data/fields/hyperlink-default.html","topicHref":"data/fields/hyperlink-default.html","topicUid":"Basics.Data.Fields.Hyperlink-Default"},{"name":"Hyperlink Library (file lists)","href":"data/fields/hyperlink-library.html","topicHref":"data/fields/hyperlink-library.html","topicUid":"Basics.Data.Fields.Hyperlink-Library"},{"name":" "},{"name":"Number Fields","href":"data/fields/number.html","topicHref":"data/fields/number.html","topicUid":"Basics.Data.Fields.Number"},{"name":"Number Default","href":"data/fields/number-default.html","topicHref":"data/fields/number-default.html","topicUid":"Basics.Data.Fields.Number-Default"},{"name":"Number Dropdown","href":"data/fields/number-dropdown.html","topicHref":"data/fields/number-dropdown.html","topicUid":"Basics.Data.Fields.Number-Dropdown"},{"name":" "},{"name":"String / Text Fields","href":"data/fields/string.html","topicHref":"data/fields/string.html","topicUid":"Basics.Data.Fields.String"},{"name":"String Default","href":"data/fields/string-default.html","topicHref":"data/fields/string-default.html","topicUid":"Basics.Data.Fields.String-Default"},{"name":"String Dropdown","href":"data/fields/string-dropdown.html","topicHref":"data/fields/string-dropdown.html","topicUid":"Basics.Data.Fields.String-Dropdown"},{"name":"String Dropdown Query","href":"data/fields/string-dropdown-query.html","topicHref":"data/fields/string-dropdown-query.html","topicUid":"Basics.Data.Fields.String-Dropdown-Query"},{"name":"String WYSIWYG ✨","href":"data/fields/string-wysiwyg/index.html","topicHref":"data/fields/string-wysiwyg/index.html","topicUid":"Basics.Data.Fields.String-Wysiwyg"},{"name":"String WYSIWYG Rich ✨","href":"data/fields/string-wysiwyg/rich.html","topicHref":"data/fields/string-wysiwyg/rich.html","topicUid":"Basics.Data.Fields.String-Wysiwyg-Rich"},{"name":"String Font Icon Picker","href":"data/fields/string-font-icon-picker.html","topicHref":"data/fields/string-font-icon-picker.html","topicUid":"Basics.Data.Fields.String-Font-Icon-Picker"},{"name":"String Url Path","href":"data/fields/string-url-path.html","topicHref":"data/fields/string-url-path.html","topicUid":"Basics.Data.Fields.String-Url-Path"},{"name":" "},{"name":"Ephemeral Fields (Temporary)","href":"data/fields/ephemeral.html","topicHref":"data/fields/ephemeral.html","topicUid":"Basics.Data.Fields.Ephemeral"}]},{"name":"Entities / Data","href":"data/entities/index.html","topicHref":"data/entities/index.html","includedFrom":"~/pages/basics/data/entities/toc.yml","topicUid":"Basics.Data.Entities.Index","items":[{"name":"Technical Specs","items":[{"name":"C# Object Structure","href":"data/entities/specs/object-structure.html","topicHref":"data/entities/specs/object-structure.html","topicUid":"Basics.Data.Entities.ObjectStructure"}]}]},{"name":"Entity Relationships","href":"data/relationships/index.html","topicHref":"data/relationships/index.html","topicUid":"Basics.Data.Relationships.Index"},{"name":"Multilanguage & i18n","href":"data/multi-language/index.html","topicHref":"data/multi-language/index.html","topicUid":"Basics.Data.MultiLanguage.Index"},{"name":"Metadata","topicHref":"data/metadata.html","homepage":"data/metadata.html"},{"name":" "},{"name":"Data Export / Import","href":"data/export-import/index.html","topicHref":"data/export-import/index.html","topicUid":"Basics.Data.ExportImport.Index"},{"name":"Instance Data vs. All Data","href":"data/instance/index.html","topicHref":"data/instance/index.html","topicUid":"Basics.Data.Instance.Index"},{"name":"How data flows","href":"data/how-data-flows.html","topicHref":"data/how-data-flows.html"}]},{"name":"Content","href":"content/index.html","topicHref":"content/index.html","includedFrom":"~/pages/basics/content/toc.yml","topicUid":"Basics.Content.Index","items":[{"name":"Content Images & Files","href":"content/content-assets.html","topicHref":"content/content-assets.html","topicUid":"Basics.Content.Assets"},{"name":"Content Presentation","href":"content/presentation.html","topicHref":"content/presentation.html","topicUid":"Basics.Content.Presentation"},{"name":"Content Lists","href":"content/lists.html","topicHref":"content/lists.html","topicUid":"Basics.Content.Lists"},{"name":"Content App (special app)","href":"app/content-app/index.html","topicHref":"app/content-app/index.html","topicUid":"Basics.App.ContentApp.Index"}]},{"name":" "},{"name":"Deeper Dive"},{"name":"Principles and Values","href":"principles/index.html","topicHref":"principles/index.html","topicUid":"Basics.Principles.Index"},{"name":"Images & Resizer","href":"images/index.html","topicHref":"images/index.html","includedFrom":"~/pages/basics/images/toc.yml","topicUid":"Basics.Images.Index","items":[{"name":"Guide","href":"images/guide/index.html","topicHref":"images/guide/index.html","topicUid":"Basics.Images.Guide.Index"},{"name":"Image Resizer","href":"image-resizer/index.html","topicHref":"image-resizer/index.html","topicUid":"Basics.ImageResizer.Index"},{"name":"Image Perfection","href":"images/perfection/index.html","topicHref":"images/perfection/index.html","topicUid":"Basics.Images.Perfection.Index"}]},{"name":"Languages","href":"languages/index.html","topicHref":"languages/index.html","includedFrom":"~/pages/basics/languages/toc.yml","topicUid":"Basics.Languages.Index","items":[{"name":"Automatic Translation","href":"languages/auto-translate.html","topicHref":"languages/auto-translate.html","topicUid":"Basics.Languages.AutoTranslate.Index","items":[{"name":"Register API Key","href":"languages/auto-translate-api-key.html","topicHref":"languages/auto-translate-api-key.html","topicUid":"Basics.Languages.AutoTranslate.ApiKey"}]},{"name":"Activate Languages","href":"languages/activate-languages.html","topicHref":"languages/activate-languages.html","topicUid":"Basics.Languages.ActivateLanguages"}]},{"name":"Metadata","href":"metadata/index.html","topicHref":"metadata/index.html","includedFrom":"~/pages/basics/metadata/toc.yml","topicUid":"Basics.Metadata.Index","items":[{"name":"Metadata FOR","href":"metadata/for.html","topicHref":"metadata/for.html","topicUid":"Basics.Metadata.For"},{"name":"Metadata OF","href":"metadata/of.html","topicHref":"metadata/of.html","topicUid":"Basics.Metadata.Of"},{"name":"Create Metadata","href":"metadata/create.html","topicHref":"metadata/create.html","topicUid":"Basics.Metadata.Create"},{"name":"Read Metadata","href":"metadata/read.html","topicHref":"metadata/read.html","topicUid":"Basics.Metadata.Read"},{"name":"Target Types","href":"metadata/target-types.html","topicHref":"metadata/target-types.html","topicUid":"Basics.Metadata.TargetTypes"},{"name":"Metadata Decorators","href":"metadata/decorators/index.html","topicHref":"metadata/decorators/index.html","topicUid":"Basics.Metadata.Decorators.Index"}]},{"name":" "},{"name":"Stack Layers / Parts"},{"name":"Browser","href":"browser/index.html","topicHref":"browser/index.html","includedFrom":"~/pages/basics/browser/toc.yml","topicUid":"Basics.Browser.Index","items":[{"name":"HTML","href":"browser/html.html","topicHref":"browser/html.html","topicUid":"Basics.Browser.Html"},{"name":"Images","href":"browser/images.html","topicHref":"browser/images.html","topicUid":"Basics.Browser.Images"},{"name":"JavaScript","href":"browser/javascript.html","topicHref":"browser/javascript.html","topicUid":"Basics.Browser.JavaScript"},{"name":"CSS & Styles","href":"browser/css.html","topicHref":"browser/css.html","topicUid":"Basics.Browser.Css"},{"name":"JSON Data","href":"browser/json-data.html","topicHref":"browser/json-data.html","topicUid":"Basics.Browser.JsonData"}]},{"name":"Server","href":"server/index.html","topicHref":"server/index.html","includedFrom":"~/pages/basics/server/toc.yml","topicUid":"Basics.Server.Index","items":[{"name":"Data Flow","href":"server/data-flow.html","topicHref":"server/data-flow.html","topicUid":"Basics.Server.DataFlow"},{"name":"Razor Templates","href":"server/render/razor/index.html","topicHref":"server/render/razor/index.html","topicUid":"Basics.Server.Render.Razor.Index"},{"name":"Token Templates","href":"server/render/tokens/index.html","topicHref":"server/render/tokens/index.html","topicUid":"Basics.Server.Render.Tokens.Index"},{"name":"Asset Optimization","href":"server/asset-optimization/index.html","topicHref":"server/asset-optimization/index.html","topicUid":"Basics.Server.AssetOptimization.Index"},{"name":"WebAPIs","href":"server/web-api.html","topicHref":"server/web-api.html"},{"name":"Headless WebAPI","href":"server/web-api.html","topicHref":"server/web-api.html"},{"name":"Caching","items":[{"name":"App State Cache","href":"server/caching/app-state/app-state.html","topicHref":"server/caching/app-state/app-state.html","topicUid":"Basics.Server.Caching.AppState.Index"}]}]},{"name":"Prepare","href":"prepare/index.html","topicHref":"prepare/index.html","topicUid":"Basics.Prepare.Index"},{"name":"Query & VisualQuery","href":"query/index.html","topicHref":"query/index.html","includedFrom":"~/pages/basics/query/toc.yml","topicUid":"Basics.Query.Index","items":[{"name":"VisualQuery Designer","href":"query/visual-query/index.html","topicHref":"query/visual-query/index.html","topicUid":"Basics.Query.VisualQuery.Index"},{"name":"In Streams","href":"query/streams/in.html","topicHref":"query/streams/in.html","topicUid":"Basics.Query.Streams.In"},{"name":"Out Streams","href":"query/streams/out.html","topicHref":"query/streams/out.html","topicUid":"Basics.Query.Streams.Out"},{"name":"Parameters","href":"query/parameters/index.html","topicHref":"query/parameters/index.html","topicUid":"Basics.Query.Parameters.Index"},{"name":"Sub-Queries","href":"query/sub-query/index.html","topicHref":"query/sub-query/index.html","topicUid":"Basics.Query.SubQuery.Index"},{"name":" "},{"name":"Use in Views / Templates","href":"query/query-in-view.html","topicHref":"query/query-in-view.html","topicUid":"Basics.Query.QueryInView"},{"name":"Use in Edit-UI Dropdowns","href":"query/ref-edit-form.html","topicHref":"query/ref-edit-form.html","topicUid":"Basics.Query.EditForm"},{"name":"Use in Headless API","href":"query/ref-headless.html","topicHref":"query/ref-headless.html","topicUid":"Basics.Query.Headless"},{"name":"Use in C# Code","href":"query/ref-in-code.html","topicHref":"query/ref-in-code.html","topicUid":"Basics.Query.UseInCode"},{"name":"Export / Import","href":"query/export-import.html","topicHref":"query/export-import.html","topicUid":"Basics.Query.ExportImport"},{"name":" "},{"name":"System Queries","href":"query/query-system.html","topicHref":"query/query-system.html","topicUid":"Basics.Query.SystemQueries"},{"name":"Built-In DataSources","href":"query/data-sources/index.html","topicHref":"query/data-sources/index.html","topicUid":"Basics.Query.DataSources.Index"},{"name":"Third-Party DataSources","href":"query/data-sources/third-party.html","topicHref":"query/data-sources/third-party.html","topicUid":"Basics.Query.DataSources.ThirdParty","items":[{"name":"SharePoint DataSources","href":"query/data-sources/share-point/index.html","topicHref":"query/data-sources/share-point/index.html","topicUid":"Basics.Query.DataSources.SharePoint.Index"}]},{"name":" "},{"name":"Test-Parameters","href":"query/parameters/test-parameters.html","topicHref":"query/parameters/test-parameters.html","topicUid":"Basics.Query.Parameters.TestParameters"},{"name":"Debug VisualQuery","href":"query/debug/index.html","topicHref":"query/debug/index.html","topicUid":"Basics.Query.Debug.Index"},{"name":"Serialization/JSON tuning","href":"query/serialization/index.html","topicHref":"query/serialization/index.html","topicUid":"Basics.Query.Serialization.Index"}]},{"name":"LookUp Token System","href":"query/look-ups.html","topicHref":"query/look-ups.html","topicUid":"Basics.Query.LookUp.Index"},{"name":" "},{"name":"Editing and CMS"},{"name":"Edit UX","href":"edit/index.html","topicHref":"edit/index.html","includedFrom":"~/pages/basics/edit/toc.yml","topicUid":"Basics.Browser.Edit.Index","items":[{"name":"Edit User Experience (UX)","href":"edit/edit-ux/index.html","topicHref":"edit/edit-ux/index.html","topicUid":"Basics.Browser.EditUx.Index"},{"name":"In-Page Toolbars","href":"edit/edit-ux/toolbars/index.html","topicHref":"edit/edit-ux/toolbars/index.html","includedFrom":"~/pages/basics/edit/edit-ux/toc.yml","topicUid":"Basics.Browser.EditUx.Toolbars.Index","items":[{"name":"Toolbars","href":"edit/edit-ux/toolbars/index.html","topicHref":"edit/edit-ux/toolbars/index.html","topicUid":"Basics.Browser.EditUx.Toolbars.Index"},{"name":"Customize Toolbars","href":"edit/edit-ux/toolbars/customize.html","topicHref":"edit/edit-ux/toolbars/customize.html","topicUid":"Basics.Browser.EditUx.Toolbars.Customize"},{"name":"Button UI Rules","href":"edit/edit-ux/toolbars/button-ui.html","topicHref":"edit/edit-ux/toolbars/button-ui.html","topicUid":"Basics.Browser.EditUx.Toolbars.ButtonUi"},{"name":"Button Groups","href":"edit/edit-ux/toolbars/button-groups.html","topicHref":"edit/edit-ux/toolbars/button-groups.html","topicUid":"Basics.Browser.EditUx.Toolbars.ButtonGroups"},{"name":"Hide Advanced Features for Editors","href":"edit/edit-ux/hide-advanced-features.html","topicHref":"edit/edit-ux/hide-advanced-features.html","topicUid":"Basics.Browser.EditUx.HideAdvancedFeatures"}]},{"name":"QuickE (Quick Edit)","href":"edit/edit-ux/quick-edit.html","topicHref":"edit/edit-ux/quick-edit.html","topicUid":"Basics.Browser.EditUx.QuickE"},{"name":"Edit Form","href":"edit/edit-form/index.html","topicHref":"edit/edit-form/index.html","includedFrom":"~/pages/basics/edit/edit-form/toc.yml","topicUid":"Basics.Browser.EditForm.Index","items":[{"name":"Fields (to doc)","href":"edit/edit-form/fields.html","topicHref":"edit/edit-form/fields.html","topicUid":"Basics.Browser.EditForm.Fields"},{"name":"Field Validation (to doc)","href":"edit/edit-form/field-validation.html","topicHref":"edit/edit-form/field-validation.html","topicUid":"Basics.Browser.EditForm.FieldValidation"},{"name":"Dropdowns with Data #todoc"},{"name":"Custom Fields in the Edit Form","href":"edit/edit-form/custom-fields.html","topicHref":"edit/edit-form/custom-fields.html","topicUid":"Basics.Browser.EditForm.CustomFields"}]},{"name":"Formulas Σ in Edit Form","href":"edit/formulas/index.html","topicHref":"edit/formulas/index.html","topicUid":"Basics.Edit.Formulas.Index"},{"name":"How the Edit-Context works","href":"edit/edit-ux/context.html","topicHref":"edit/edit-ux/context.html","topicUid":"Basics.Browser.EditUx.EditContext"}]},{"name":"Content Management","href":"cms/index.html","topicHref":"cms/index.html","includedFrom":"~/pages/basics/cms/toc.yml","topicUid":"Basics.Cms.Index","items":[{"name":"ADAM Asset Management","href":"cms/adam/index.html","topicHref":"cms/adam/index.html","topicUid":"Basics.Cms.Adam.Index"},{"name":"Full-Text Search in Dnn ☢️","href":"cms/search/index.html","topicHref":"cms/search/index.html","topicUid":"Basics.Cms.Search.Index"},{"name":" "},{"name":"Content Blocks","href":"cms/content-blocks/index.html","topicHref":"cms/content-blocks/index.html","topicUid":"Basics.Cms.ContentBlocks.Index"},{"name":"Inner Content Blocks","href":"cms/content-blocks/inner-content.html","topicHref":"cms/content-blocks/inner-content.html","topicUid":"Basics.Cms.ContentBlocks.InnerContent"},{"name":"Inner Content (app in app)","href":"cms/inner-content/index.html","topicHref":"cms/inner-content/index.html","topicUid":"Basics.Cms.InnerContent.Index"},{"name":"Content Blocks in Dnn ☢️","href":"cms/content-blocks/content-blocks-in-dnn.html","topicHref":"cms/content-blocks/content-blocks-in-dnn.html","topicUid":"Basics.Cms.ContentBlocks.Dnn"},{"name":" "},{"name":"Page Publishing Workflow","href":"cms/page-publishing/index.html","topicHref":"cms/page-publishing/index.html","topicUid":"Basics.Cms.PagePublishing.Index"},{"name":"Permissions","href":"cms/permissions/index.html","topicHref":"cms/permissions/index.html","topicUid":"Basics.Cms.Permissions.Index"}]},{"name":"Settings & Configuration","href":"configuration/index.html","topicHref":"configuration/index.html","includedFrom":"~/pages/basics/configuration/toc.yml","topicUid":"Basics.Configuration.Index","items":[{"name":"Settings Stack","href":"configuration/settings-stack.html","topicHref":"configuration/settings-stack.html","topicUid":"Basics.Configuration.SettingsStack"},{"name":"System Settings","href":"configuration/settings-system.html","topicHref":"configuration/settings-system.html","topicUid":"Basics.Configuration.SettingsSystem"},{"name":"Image Resize Settings","href":"configuration/settings/images/index.html","topicHref":"configuration/settings/images/index.html","topicUid":"Basics.Configuration.Settings.Images.Index"},{"name":"Image Resize Recipes","href":"configuration/settings/images/recipes.html","topicHref":"configuration/settings/images/recipes.html","topicUid":"Basics.Configuration.Settings.Images.Recipes"},{"name":" "},{"name":"Google Maps Settings","href":"configuration/settings/google-maps.html","topicHref":"configuration/settings/google-maps.html","topicUid":"Basics.Configuration.Settings.GoogleMaps"},{"name":"WebResources (JS/CSS)","href":"configuration/settings/settings-webresources.html","topicHref":"configuration/settings/settings-webresources.html","topicUid":"Basics.Configuration.Settings.WebResources"},{"name":" "},{"name":"Resources Stack","href":"configuration/resources-stack.html","topicHref":"configuration/resources-stack.html","topicUid":"Basics.Configuration.ResourcesStack"},{"name":"System Resources","href":"configuration/resources-system.html","topicHref":"configuration/resources-system.html","topicUid":"Basics.Configuration.ResourcesSystem"},{"name":" "},{"name":"Preset Override (advanced)","href":"configuration/preset-override.html","topicHref":"configuration/preset-override.html","topicUid":"Basics.Configuration.PresetOverride"}]},{"name":"Polymorphism","href":"polymorphism/index.html","topicHref":"polymorphism/index.html","topicUid":"Basics.Polymorphism.Index"},{"name":" "},{"name":"Productivity"},{"name":"Notes 📝","href":"notes/index.html","topicHref":"notes/index.html","topicUid":"Basics.Notes"},{"name":" "},{"name":"Mobile Apps & PWAs","href":"mobile-apps/index.html","topicHref":"mobile-apps/index.html","topicUid":"Basics.MobileApps.Index"},{"name":" "},{"name":"Licenses & Features","href":"licenses-features/index.html","topicHref":"licenses-features/index.html","includedFrom":"~/pages/basics/licenses-features/toc.yml","topicUid":"Basics.LnF.Index","items":[{"name":"Licenses","href":"licenses-features/licenses/index.html","topicHref":"licenses-features/licenses/index.html","topicUid":"Basics.LnF.Licenses.Index","items":[{"name":"Enterprise Licenses","href":"licenses-features/licenses/enterprise.html","topicHref":"licenses-features/licenses/enterprise.html","topicUid":"Basics.LnF.Licenses.Enterprise"},{"name":"Debug License Issues","href":"licenses-features/licenses/debug.html","topicHref":"licenses-features/licenses/debug.html","topicUid":"Basics.LnF.Licenses.Debug"},{"name":"Warning: Registration not valid","href":"licenses-features/licenses/warning.html","topicHref":"licenses-features/licenses/warning.html","topicUid":"Basics.LnF.Licenses.Warning"}]},{"name":"Features Management","href":"licenses-features/features.html","topicHref":"licenses-features/features.html","topicUid":"Basics.LnF.Features.Index"}]},{"name":"Permissions","href":"permissions/index.html","topicHref":"permissions/index.html","topicUid":"Basics.Permissions.Index","items":[{"name":"Permissions Overview","href":"permissions/index.html","topicHref":"permissions/index.html","topicUid":"Basics.Permissions.Index"},{"name":"Restrict Admins to Content-Admin","href":"permissions/role-2sxcadministrators.html","topicHref":"permissions/role-2sxcadministrators.html","topicUid":"Basics.Permissions.Role.2sxcAdministrators"}]},{"name":"Style Guide #todoc","href":"style-guide/index.html","topicHref":"style-guide/index.html","topicUid":"Basics.StyleGuide.Index","items":[{"name":"Style Guide 2021 WIP","href":"style-guide/style-guide-2020.html","topicHref":"style-guide/style-guide-2020.html","topicUid":"Basics.StyleGuide.2021"}]}]} +{"items":[{"name":"Basics Overview","href":"index.html","topicHref":"index.html"},{"name":"App","href":"app/index.html","topicHref":"app/index.html","includedFrom":"~/pages/basics/app/toc.yml","topicUid":"Basics.App.Index","items":[{"name":"Folders, Files & Icons","href":"app/folders-and-files/index.html","topicHref":"app/folders-and-files/index.html","includedFrom":"~/pages/basics/app/folders-and-files/toc.yml","topicUid":"Basics.App.FoldersAndFiles.Index","items":[{"name":"App Folder","href":"app/folders-and-files/index.html","topicHref":"app/folders-and-files/index.html","topicUid":"Basics.App.FoldersAndFiles.Index"},{"name":"App_Data Folder","href":"app/folders-and-files/folder-app-data.html","topicHref":"app/folders-and-files/folder-app-data.html","topicUid":"Basics.App.FoldersAndFiles.FolderAppData"},{"name":"app.json Configuration File","href":"app/folders-and-files/app-json.html","topicHref":"app/folders-and-files/app-json.html","topicUid":"Basics.App.FoldersAndFiles.AppJson"},{"name":"App Assets (JS, Logos, …)","href":"app/folders-and-files/assets.html","topicHref":"app/folders-and-files/assets.html","topicUid":"Basics.App.FoldersAndFiles.Assets"},{"name":"Icons","href":"app/folders-and-files/icons.html","topicHref":"app/folders-and-files/icons.html","topicUid":"Basics.App.FoldersAndFiles.Icons"}]},{"name":"Views","href":"app/views/index.html","topicHref":"app/views/index.html","topicUid":"Basics.App.Views.Index","items":[{"name":"View Configuration","href":"app/views/configuration.html","topicHref":"app/views/configuration.html","topicUid":"Basics.App.Views.Configuration"},{"name":"View Settings","href":"app/views/settings.html","topicHref":"app/views/settings.html","topicUid":"Basics.App.Views.Settings"},{"name":"View Resources","href":"app/views/resources.html","topicHref":"app/views/resources.html","topicUid":"Basics.App.Views.Resources"},{"name":"View Templates","href":"app/templates.html","topicHref":"app/templates.html","topicUid":"Basics.App.Templates"}]},{"name":"WebAPIs","href":"app/web-api.html","topicHref":"app/web-api.html"},{"name":"Special Apps","items":[{"name":"The Content App","href":"app/content-app/index.html","topicHref":"app/content-app/index.html","topicUid":"Basics.App.ContentApp.Index"},{"name":"The Primary App","href":"app/primary-app/index.html","topicHref":"app/primary-app/index.html","topicUid":"Basics.App.PrimaryApp.Index"},{"name":"Inherit Apps on many Sites","href":"app/inherit/index.html","topicHref":"app/inherit/index.html","topicUid":"Basics.App.InheritApps.Index"}]},{"name":"Config, Settings & Permissions","items":[{"name":"App Configuration","href":"app/configuration.html","topicHref":"app/configuration.html","topicUid":"Basics.App.Configuration"},{"name":"App Settings","href":"app/settings.html","topicHref":"app/settings.html","topicUid":"Basics.App.Settings"},{"name":"App Resources","href":"app/resources.html","topicHref":"app/resources.html","topicUid":"Basics.App.Resources"},{"name":"App Permissions","href":"app/permissions.html","topicHref":"app/permissions.html","topicUid":"Basics.App.Permissions"}]},{"name":"Export, Import & Git","items":[{"name":"App Export & Import","href":"app/export-import/index.html","topicHref":"app/export-import/index.html","topicUid":"Basics.App.ExportImport.Index"},{"name":"Configure Export w/app.json","href":"app/export-import/app-json.html","topicHref":"app/export-import/app-json.html","topicUid":"Basics.App.ExportImport.App.Json"},{"name":"App Git Integration","href":"app/git/index.html","topicHref":"app/git/index.html","topicUid":"Basics.App.Git.Index"}]}]},{"name":"Data","href":"data/index.html","topicHref":"data/index.html","includedFrom":"~/pages/basics/data/toc.yml","topicUid":"Basics.Data.Index","items":[{"name":"Content-Types","href":"data/content-types/index.html","topicHref":"data/content-types/index.html","includedFrom":"~/pages/basics/data/content-types/toc.yml","topicUid":"Basics.Data.ContentTypes.Index","items":[{"name":"App Content-Types","href":"data/content-types/range-app.html","topicHref":"data/content-types/range-app.html","topicUid":"Basics.Data.ContentTypes.App"},{"name":"App Shared Content-Types","href":"data/content-types/range-app-shared.html","topicHref":"data/content-types/range-app-shared.html","topicUid":"Basics.Data.ContentTypes.Shared"},{"name":"System Content-Types","href":"data/content-types/range-global-system.html","topicHref":"data/content-types/range-global-system.html","topicUid":"Basics.Data.ContentTypes.System"},{"name":"Global Content-Types","href":"data/content-types/range-global.html","topicHref":"data/content-types/range-global.html","topicUid":"Basics.Data.ContentTypes.Global"},{"name":"Content-Type Scopes","href":"data/content-types/scopes.html","topicHref":"data/content-types/scopes.html","topicUid":"Basics.Data.Scopes"},{"name":"Content-Type Names","href":"data/content-types/names.html","topicHref":"data/content-types/names.html","topicUid":"Basics.Data.ContentTypes.Names"},{"name":"Technical Specs","href":"data/content-types/specs/index.html","topicHref":"data/content-types/specs/index.html","topicUid":"Basics.Data.ContentTypes.Technical.Index","items":[{"name":"SQL Storage","href":"data/content-types/specs/sql-storage.html","topicHref":"data/content-types/specs/sql-storage.html","topicUid":"Basics.Data.ContentTypes.SqlStorage"},{"name":"File Storage","href":"data/content-types/specs/file-storage.html","topicHref":"data/content-types/specs/file-storage.html","topicUid":"Basics.Data.ContentTypes.FileStorage"},{"name":"C# Object Structure","href":"data/content-types/specs/object-structure.html","topicHref":"data/content-types/specs/object-structure.html","topicUid":"Basics.Data.ContentTypes.ObjectStructure"}]}]},{"name":"Fields / Attributes","href":"data/fields/index.html","topicHref":"data/fields/index.html","includedFrom":"~/pages/basics/data/fields/toc.yml","topicUid":"Basics.Data.Fields.Index","items":[{"name":"General Field Settings","href":"data/fields/all.html","topicHref":"data/fields/all.html","topicUid":"Basics.Data.Fields.GeneralSettings"},{"name":"Boolean Fields","href":"data/fields/boolean.html","topicHref":"data/fields/boolean.html","topicUid":"Basics.Data.Fields.Boolean","items":[{"name":"Boolean Default","href":"data/fields/boolean-default.html","topicHref":"data/fields/boolean-default.html","topicUid":"Basics.Data.Fields.Boolean-Default"},{"name":"Boolean Tristate","href":"data/fields/boolean-tristate.html","topicHref":"data/fields/boolean-tristate.html","topicUid":"Basics.Data.Fields.Boolean-Tristate"}]},{"name":"Date/Time Fields","href":"data/fields/datetime.html","topicHref":"data/fields/datetime.html","topicUid":"Basics.Data.Fields.DateTime","items":[{"name":"DateTime Default","href":"data/fields/datetime-default.html","topicHref":"data/fields/datetime-default.html","topicUid":"Basics.Data.Fields.DateTime-Default"}]},{"name":"Custom Fields / GPS","href":"data/fields/custom.html","topicHref":"data/fields/custom.html","topicUid":"Basics.Data.Fields.Custom","items":[{"name":"Custom GPS","href":"data/fields/custom-gps.html","topicHref":"data/fields/custom-gps.html","topicUid":"Basics.Data.Fields.CustomGps"}]},{"name":"Empty Fields (Groups)","href":"data/fields/empty.html","topicHref":"data/fields/empty.html","topicUid":"Basics.Data.Fields.Empty","items":[{"name":"Empty Default (new Group)","href":"data/fields/empty-default.html","topicHref":"data/fields/empty-default.html","topicUid":"Basics.Data.Fields.Empty-Default"},{"name":"Empty End (close a Group)","href":"data/fields/empty-end.html","topicHref":"data/fields/empty-end.html","topicUid":"Basics.Data.Fields.Empty-End"},{"name":"Empty Message","href":"data/fields/empty-message.html","topicHref":"data/fields/empty-message.html","topicUid":"Basics.Data.Fields.Empty-Message"}]},{"name":"Entity Fields (Relationships)","href":"data/fields/entity.html","topicHref":"data/fields/entity.html","topicUid":"Basics.Data.Fields.Entity","items":[{"name":"Entity Default","href":"data/fields/entity-default.html","topicHref":"data/fields/entity-default.html","topicUid":"Basics.Data.Fields.Entity-Default"},{"name":"Entity from Query","href":"data/fields/entity-query.html","topicHref":"data/fields/entity-query.html","topicUid":"Basics.Data.Fields.Entity-Query"}]},{"name":"Hyperlink Fields / Files","href":"data/fields/hyperlink.html","topicHref":"data/fields/hyperlink.html","topicUid":"Basics.Data.Fields.Hyperlink","items":[{"name":"Hyperlink Default (single item)","href":"data/fields/hyperlink-default.html","topicHref":"data/fields/hyperlink-default.html","topicUid":"Basics.Data.Fields.Hyperlink-Default"},{"name":"Hyperlink Library (file lists)","href":"data/fields/hyperlink-library.html","topicHref":"data/fields/hyperlink-library.html","topicUid":"Basics.Data.Fields.Hyperlink-Library"}]},{"name":"Number Fields","href":"data/fields/number.html","topicHref":"data/fields/number.html","topicUid":"Basics.Data.Fields.Number","items":[{"name":"Number Default","href":"data/fields/number-default.html","topicHref":"data/fields/number-default.html","topicUid":"Basics.Data.Fields.Number-Default"},{"name":"Number Dropdown","href":"data/fields/number-dropdown.html","topicHref":"data/fields/number-dropdown.html","topicUid":"Basics.Data.Fields.Number-Dropdown"}]},{"name":"String / Text / WYSIWYG Fields","href":"data/fields/string.html","topicHref":"data/fields/string.html","topicUid":"Basics.Data.Fields.String","items":[{"name":"String Default","href":"data/fields/string-default.html","topicHref":"data/fields/string-default.html","topicUid":"Basics.Data.Fields.String-Default"},{"name":"String Dropdown","href":"data/fields/string-dropdown.html","topicHref":"data/fields/string-dropdown.html","topicUid":"Basics.Data.Fields.String-Dropdown"},{"name":"String Dropdown Query","href":"data/fields/string-dropdown-query.html","topicHref":"data/fields/string-dropdown-query.html","topicUid":"Basics.Data.Fields.String-Dropdown-Query"},{"name":"String WYSIWYG ✨","href":"data/fields/string-wysiwyg/index.html","topicHref":"data/fields/string-wysiwyg/index.html","topicUid":"Basics.Data.Fields.String-Wysiwyg"},{"name":"String WYSIWYG Rich ✨","href":"data/fields/string-wysiwyg/rich.html","topicHref":"data/fields/string-wysiwyg/rich.html","topicUid":"Basics.Data.Fields.String-Wysiwyg-Rich"},{"name":"String Font Icon Picker","href":"data/fields/string-font-icon-picker.html","topicHref":"data/fields/string-font-icon-picker.html","topicUid":"Basics.Data.Fields.String-Font-Icon-Picker"},{"name":"String Url Path","href":"data/fields/string-url-path.html","topicHref":"data/fields/string-url-path.html","topicUid":"Basics.Data.Fields.String-Url-Path"}]},{"name":"Ephemeral Fields (Temporary)","href":"data/fields/ephemeral.html","topicHref":"data/fields/ephemeral.html","topicUid":"Basics.Data.Fields.Ephemeral"}]},{"name":"Entities / Data","href":"data/entities/index.html","topicHref":"data/entities/index.html","includedFrom":"~/pages/basics/data/entities/toc.yml","topicUid":"Basics.Data.Entities.Index","items":[{"name":"Technical Specs","items":[{"name":"C# Object Structure","href":"data/entities/specs/object-structure.html","topicHref":"data/entities/specs/object-structure.html","topicUid":"Basics.Data.Entities.ObjectStructure"}]}]},{"name":"Entity Relationships","href":"data/relationships/index.html","topicHref":"data/relationships/index.html","topicUid":"Basics.Data.Relationships.Index"},{"name":"Multi-Language & i18n","href":"data/multi-language/index.html","topicHref":"data/multi-language/index.html","topicUid":"Basics.Data.MultiLanguage.Index"},{"name":"Metadata","href":"data/metadata.html","topicHref":"data/metadata.html"},{"name":" "},{"name":"Data Export / Import","href":"data/export-import/index.html","topicHref":"data/export-import/index.html","topicUid":"Basics.Data.ExportImport.Index"},{"name":"Instance Data vs. All Data","href":"data/instance/index.html","topicHref":"data/instance/index.html","topicUid":"Basics.Data.Instance.Index"},{"name":"How data flows","href":"data/how-data-flows.html","topicHref":"data/how-data-flows.html"}]},{"name":"Content","href":"content/index.html","topicHref":"content/index.html","includedFrom":"~/pages/basics/content/toc.yml","topicUid":"Basics.Content.Index","items":[{"name":"Content Images & Files","href":"content/content-assets.html","topicHref":"content/content-assets.html","topicUid":"Basics.Content.Assets"},{"name":"Content Presentation","href":"content/presentation.html","topicHref":"content/presentation.html","topicUid":"Basics.Content.Presentation"},{"name":"Content Lists","href":"content/lists.html","topicHref":"content/lists.html","topicUid":"Basics.Content.Lists"},{"name":"Content App (special app)","href":"app/content-app/index.html","topicHref":"app/content-app/index.html","topicUid":"Basics.App.ContentApp.Index"}]},{"name":"Deeper Dive"},{"name":"Principles and Values","href":"principles/index.html","topicHref":"principles/index.html","topicUid":"Basics.Principles.Index"},{"name":"Images & Resizer","href":"images/index.html","topicHref":"images/index.html","includedFrom":"~/pages/basics/images/toc.yml","topicUid":"Basics.Images.Index","items":[{"name":"Guide","href":"images/guide/index.html","topicHref":"images/guide/index.html","topicUid":"Basics.Images.Guide.Index"},{"name":"Image Resizer","href":"image-resizer/index.html","topicHref":"image-resizer/index.html","topicUid":"Basics.ImageResizer.Index"},{"name":"Image Perfection","href":"images/perfection/index.html","topicHref":"images/perfection/index.html","topicUid":"Basics.Images.Perfection.Index"}]},{"name":"Languages","href":"languages/index.html","topicHref":"languages/index.html","includedFrom":"~/pages/basics/languages/toc.yml","topicUid":"Basics.Languages.Index","items":[{"name":"Automatic Translation","href":"languages/auto-translate.html","topicHref":"languages/auto-translate.html","topicUid":"Basics.Languages.AutoTranslate.Index","items":[{"name":"Register API Key","href":"languages/auto-translate-api-key.html","topicHref":"languages/auto-translate-api-key.html","topicUid":"Basics.Languages.AutoTranslate.ApiKey"}]},{"name":"Activate Languages","href":"languages/activate-languages.html","topicHref":"languages/activate-languages.html","topicUid":"Basics.Languages.ActivateLanguages"}]},{"name":"Metadata","href":"metadata/index.html","topicHref":"metadata/index.html","includedFrom":"~/pages/basics/metadata/toc.yml","topicUid":"Basics.Metadata.Index","items":[{"name":"Metadata FOR","href":"metadata/for.html","topicHref":"metadata/for.html","topicUid":"Basics.Metadata.For"},{"name":"Metadata OF","href":"metadata/of.html","topicHref":"metadata/of.html","topicUid":"Basics.Metadata.Of"},{"name":"Create Metadata","href":"metadata/create.html","topicHref":"metadata/create.html","topicUid":"Basics.Metadata.Create"},{"name":"Read Metadata","href":"metadata/read.html","topicHref":"metadata/read.html","topicUid":"Basics.Metadata.Read"},{"name":"Target Types","href":"metadata/target-types.html","topicHref":"metadata/target-types.html","topicUid":"Basics.Metadata.TargetTypes"},{"name":"Metadata Decorators","href":"metadata/decorators/index.html","topicHref":"metadata/decorators/index.html","topicUid":"Basics.Metadata.Decorators.Index"}]},{"name":"Stack Layers / Parts"},{"name":"Browser","href":"browser/index.html","topicHref":"browser/index.html","includedFrom":"~/pages/basics/browser/toc.yml","topicUid":"Basics.Browser.Index","items":[{"name":"HTML","href":"browser/html.html","topicHref":"browser/html.html","topicUid":"Basics.Browser.Html"},{"name":"Images","href":"browser/images.html","topicHref":"browser/images.html","topicUid":"Basics.Browser.Images"},{"name":"JavaScript","href":"browser/javascript.html","topicHref":"browser/javascript.html","topicUid":"Basics.Browser.JavaScript"},{"name":"CSS & Styles","href":"browser/css.html","topicHref":"browser/css.html","topicUid":"Basics.Browser.Css"},{"name":"JSON Data","href":"browser/json-data.html","topicHref":"browser/json-data.html","topicUid":"Basics.Browser.JsonData"}]},{"name":"Server","href":"server/index.html","topicHref":"server/index.html","includedFrom":"~/pages/basics/server/toc.yml","topicUid":"Basics.Server.Index","items":[{"name":"Data Flow","href":"server/data-flow.html","topicHref":"server/data-flow.html","topicUid":"Basics.Server.DataFlow"},{"name":"Razor Templates","href":"server/render/razor/index.html","topicHref":"server/render/razor/index.html","topicUid":"Basics.Server.Render.Razor.Index"},{"name":"Token Templates","href":"server/render/tokens/index.html","topicHref":"server/render/tokens/index.html","topicUid":"Basics.Server.Render.Tokens.Index"},{"name":"Asset Optimization","href":"server/asset-optimization/index.html","topicHref":"server/asset-optimization/index.html","topicUid":"Basics.Server.AssetOptimization.Index"},{"name":"WebAPIs","href":"server/web-api.html","topicHref":"server/web-api.html"},{"name":"Headless WebAPI","href":"server/web-api.html","topicHref":"server/web-api.html"},{"name":"Caching","items":[{"name":"App State Cache","href":"server/caching/app-state/app-state.html","topicHref":"server/caching/app-state/app-state.html","topicUid":"Basics.Server.Caching.AppState.Index"}]}]},{"name":"Prepare","href":"prepare/index.html","topicHref":"prepare/index.html","topicUid":"Basics.Prepare.Index"},{"name":"Query & VisualQuery","href":"query/index.html","topicHref":"query/index.html","includedFrom":"~/pages/basics/query/toc.yml","topicUid":"Basics.Query.Index","items":[{"name":"VisualQuery Designer","href":"query/visual-query/index.html","topicHref":"query/visual-query/index.html","topicUid":"Basics.Query.VisualQuery.Index"},{"name":"In Streams","href":"query/streams/in.html","topicHref":"query/streams/in.html","topicUid":"Basics.Query.Streams.In"},{"name":"Out Streams","href":"query/streams/out.html","topicHref":"query/streams/out.html","topicUid":"Basics.Query.Streams.Out"},{"name":"Parameters","href":"query/parameters/index.html","topicHref":"query/parameters/index.html","topicUid":"Basics.Query.Parameters.Index"},{"name":"Sub-Queries","href":"query/sub-query/index.html","topicHref":"query/sub-query/index.html","topicUid":"Basics.Query.SubQuery.Index"},{"name":" "},{"name":"Use in Views / Templates","href":"query/query-in-view.html","topicHref":"query/query-in-view.html","topicUid":"Basics.Query.QueryInView"},{"name":"Use in Edit-UI Dropdowns","href":"query/ref-edit-form.html","topicHref":"query/ref-edit-form.html","topicUid":"Basics.Query.EditForm"},{"name":"Use in Headless API","href":"query/ref-headless.html","topicHref":"query/ref-headless.html","topicUid":"Basics.Query.Headless"},{"name":"Use in C# Code","href":"query/ref-in-code.html","topicHref":"query/ref-in-code.html","topicUid":"Basics.Query.UseInCode"},{"name":"Export / Import","href":"query/export-import.html","topicHref":"query/export-import.html","topicUid":"Basics.Query.ExportImport"},{"name":" "},{"name":"System Queries","href":"query/query-system.html","topicHref":"query/query-system.html","topicUid":"Basics.Query.SystemQueries"},{"name":"Built-In DataSources","href":"query/data-sources/index.html","topicHref":"query/data-sources/index.html","topicUid":"Basics.Query.DataSources.Index"},{"name":"Third-Party DataSources","href":"query/data-sources/third-party.html","topicHref":"query/data-sources/third-party.html","topicUid":"Basics.Query.DataSources.ThirdParty","items":[{"name":"SharePoint DataSources","href":"query/data-sources/share-point/index.html","topicHref":"query/data-sources/share-point/index.html","topicUid":"Basics.Query.DataSources.SharePoint.Index"}]},{"name":" "},{"name":"Test-Parameters","href":"query/parameters/test-parameters.html","topicHref":"query/parameters/test-parameters.html","topicUid":"Basics.Query.Parameters.TestParameters"},{"name":"Debug VisualQuery","href":"query/debug/index.html","topicHref":"query/debug/index.html","topicUid":"Basics.Query.Debug.Index"},{"name":"Serialization/JSON tuning","href":"query/serialization/index.html","topicHref":"query/serialization/index.html","topicUid":"Basics.Query.Serialization.Index"}]},{"name":"LookUp Token System","href":"query/look-ups.html","topicHref":"query/look-ups.html","topicUid":"Basics.Query.LookUp.Index"},{"name":"Editing and CMS"},{"name":"Edit UX","href":"edit/index.html","topicHref":"edit/index.html","includedFrom":"~/pages/basics/edit/toc.yml","topicUid":"Basics.Browser.Edit.Index","items":[{"name":"Edit User Experience (UX)","href":"edit/edit-ux/index.html","topicHref":"edit/edit-ux/index.html","topicUid":"Basics.Browser.EditUx.Index"},{"name":"In-Page Toolbars","href":"edit/edit-ux/toolbars/index.html","topicHref":"edit/edit-ux/toolbars/index.html","includedFrom":"~/pages/basics/edit/edit-ux/toc.yml","topicUid":"Basics.Browser.EditUx.Toolbars.Index","items":[{"name":"Toolbars","href":"edit/edit-ux/toolbars/index.html","topicHref":"edit/edit-ux/toolbars/index.html","topicUid":"Basics.Browser.EditUx.Toolbars.Index"},{"name":"Customize Toolbars","href":"edit/edit-ux/toolbars/customize.html","topicHref":"edit/edit-ux/toolbars/customize.html","topicUid":"Basics.Browser.EditUx.Toolbars.Customize"},{"name":"Button UI Rules","href":"edit/edit-ux/toolbars/button-ui.html","topicHref":"edit/edit-ux/toolbars/button-ui.html","topicUid":"Basics.Browser.EditUx.Toolbars.ButtonUi"},{"name":"Button Groups","href":"edit/edit-ux/toolbars/button-groups.html","topicHref":"edit/edit-ux/toolbars/button-groups.html","topicUid":"Basics.Browser.EditUx.Toolbars.ButtonGroups"},{"name":"Hide Advanced Features for Editors","href":"edit/edit-ux/hide-advanced-features.html","topicHref":"edit/edit-ux/hide-advanced-features.html","topicUid":"Basics.Browser.EditUx.HideAdvancedFeatures"}]},{"name":"QuickE (Quick Edit)","href":"edit/edit-ux/quick-edit.html","topicHref":"edit/edit-ux/quick-edit.html","topicUid":"Basics.Browser.EditUx.QuickE"},{"name":"Edit Form","href":"edit/edit-form/index.html","topicHref":"edit/edit-form/index.html","includedFrom":"~/pages/basics/edit/edit-form/toc.yml","topicUid":"Basics.Browser.EditForm.Index","items":[{"name":"Fields (to doc)","href":"edit/edit-form/fields.html","topicHref":"edit/edit-form/fields.html","topicUid":"Basics.Browser.EditForm.Fields"},{"name":"Field Validation (to doc)","href":"edit/edit-form/field-validation.html","topicHref":"edit/edit-form/field-validation.html","topicUid":"Basics.Browser.EditForm.FieldValidation"},{"name":"Dropdowns with Data #todoc"},{"name":"Custom Fields in the Edit Form","href":"edit/edit-form/custom-fields.html","topicHref":"edit/edit-form/custom-fields.html","topicUid":"Basics.Browser.EditForm.CustomFields"}]},{"name":"Formulas Σ in Edit Form","href":"edit/formulas/index.html","topicHref":"edit/formulas/index.html","topicUid":"Basics.Edit.Formulas.Index"},{"name":"How the Edit-Context works","href":"edit/edit-ux/context.html","topicHref":"edit/edit-ux/context.html","topicUid":"Basics.Browser.EditUx.EditContext"}]},{"name":"Content Management","href":"cms/index.html","topicHref":"cms/index.html","includedFrom":"~/pages/basics/cms/toc.yml","topicUid":"Basics.Cms.Index","items":[{"name":"ADAM Asset Management","href":"cms/adam/index.html","topicHref":"cms/adam/index.html","topicUid":"Basics.Cms.Adam.Index"},{"name":"Full-Text Search in Dnn ☢️","href":"cms/search/index.html","topicHref":"cms/search/index.html","topicUid":"Basics.Cms.Search.Index"},{"name":" "},{"name":"Content Blocks","href":"cms/content-blocks/index.html","topicHref":"cms/content-blocks/index.html","topicUid":"Basics.Cms.ContentBlocks.Index"},{"name":"Inner Content Blocks","href":"cms/content-blocks/inner-content.html","topicHref":"cms/content-blocks/inner-content.html","topicUid":"Basics.Cms.ContentBlocks.InnerContent"},{"name":"Inner Content (app in app)","href":"cms/inner-content/index.html","topicHref":"cms/inner-content/index.html","topicUid":"Basics.Cms.InnerContent.Index"},{"name":"Content Blocks in Dnn ☢️","href":"cms/content-blocks/content-blocks-in-dnn.html","topicHref":"cms/content-blocks/content-blocks-in-dnn.html","topicUid":"Basics.Cms.ContentBlocks.Dnn"},{"name":" "},{"name":"Page Publishing Workflow","href":"cms/page-publishing/index.html","topicHref":"cms/page-publishing/index.html","topicUid":"Basics.Cms.PagePublishing.Index"},{"name":"Permissions","href":"cms/permissions/index.html","topicHref":"cms/permissions/index.html","topicUid":"Basics.Cms.Permissions.Index"}]},{"name":"Settings & Configuration","href":"configuration/index.html","topicHref":"configuration/index.html","includedFrom":"~/pages/basics/configuration/toc.yml","topicUid":"Basics.Configuration.Index","items":[{"name":"Settings Stack","href":"configuration/settings-stack.html","topicHref":"configuration/settings-stack.html","topicUid":"Basics.Configuration.SettingsStack"},{"name":"System Settings","href":"configuration/settings-system.html","topicHref":"configuration/settings-system.html","topicUid":"Basics.Configuration.SettingsSystem"},{"name":"Image Resize Settings","href":"configuration/settings/images/index.html","topicHref":"configuration/settings/images/index.html","topicUid":"Basics.Configuration.Settings.Images.Index"},{"name":"Image Resize Recipes","href":"configuration/settings/images/recipes.html","topicHref":"configuration/settings/images/recipes.html","topicUid":"Basics.Configuration.Settings.Images.Recipes"},{"name":" "},{"name":"Google Maps Settings","href":"configuration/settings/google-maps.html","topicHref":"configuration/settings/google-maps.html","topicUid":"Basics.Configuration.Settings.GoogleMaps"},{"name":"WebResources (JS/CSS)","href":"configuration/settings/settings-webresources.html","topicHref":"configuration/settings/settings-webresources.html","topicUid":"Basics.Configuration.Settings.WebResources"},{"name":" "},{"name":"Resources Stack","href":"configuration/resources-stack.html","topicHref":"configuration/resources-stack.html","topicUid":"Basics.Configuration.ResourcesStack"},{"name":"System Resources","href":"configuration/resources-system.html","topicHref":"configuration/resources-system.html","topicUid":"Basics.Configuration.ResourcesSystem"},{"name":" "},{"name":"Preset Override (advanced)","href":"configuration/preset-override.html","topicHref":"configuration/preset-override.html","topicUid":"Basics.Configuration.PresetOverride"}]},{"name":"Polymorphism","href":"polymorphism/index.html","topicHref":"polymorphism/index.html","topicUid":"Basics.Polymorphism.Index"},{"name":"Productivity"},{"name":"Notes 📝","href":"notes/index.html","topicHref":"notes/index.html","topicUid":"Basics.Notes"},{"name":"Other Topics"},{"name":"Mobile Apps & PWAs","href":"mobile-apps/index.html","topicHref":"mobile-apps/index.html","topicUid":"Basics.MobileApps.Index"},{"name":"Licenses & Features","href":"licenses-features/index.html","topicHref":"licenses-features/index.html","includedFrom":"~/pages/basics/licenses-features/toc.yml","topicUid":"Basics.LnF.Index","items":[{"name":"Licenses","href":"licenses-features/licenses/index.html","topicHref":"licenses-features/licenses/index.html","topicUid":"Basics.LnF.Licenses.Index","items":[{"name":"Enterprise Licenses","href":"licenses-features/licenses/enterprise.html","topicHref":"licenses-features/licenses/enterprise.html","topicUid":"Basics.LnF.Licenses.Enterprise"},{"name":"Debug License Issues","href":"licenses-features/licenses/debug.html","topicHref":"licenses-features/licenses/debug.html","topicUid":"Basics.LnF.Licenses.Debug"},{"name":"Warning: Registration not valid","href":"licenses-features/licenses/warning.html","topicHref":"licenses-features/licenses/warning.html","topicUid":"Basics.LnF.Licenses.Warning"}]},{"name":"Features Management","href":"licenses-features/features.html","topicHref":"licenses-features/features.html","topicUid":"Basics.LnF.Features.Index"}]},{"name":"Permissions","href":"permissions/index.html","topicHref":"permissions/index.html","topicUid":"Basics.Permissions.Index","items":[{"name":"Permissions Overview","href":"permissions/index.html","topicHref":"permissions/index.html","topicUid":"Basics.Permissions.Index"},{"name":"Restrict Admins to Content-Admin","href":"permissions/role-2sxcadministrators.html","topicHref":"permissions/role-2sxcadministrators.html","topicUid":"Basics.Permissions.Role.2sxcAdministrators"}]},{"name":"Style Guide #todoc","href":"style-guide/index.html","topicHref":"style-guide/index.html","topicUid":"Basics.StyleGuide.Index","items":[{"name":"Style Guide 2021 WIP","href":"style-guide/style-guide-2020.html","topicHref":"style-guide/style-guide-2020.html","topicUid":"Basics.StyleGuide.2021"}]}]} diff --git a/docs/guides/app-development/toc.html b/docs/guides/app-development/toc.html index ff7ec5558..b3b93b032 100644 --- a/docs/guides/app-development/toc.html +++ b/docs/guides/app-development/toc.html @@ -23,7 +23,7 @@
  • - Common Problems + Common Problems
    • diff --git a/docs/guides/app-development/toc.json b/docs/guides/app-development/toc.json index 4985e134f..962b70aad 100644 --- a/docs/guides/app-development/toc.json +++ b/docs/guides/app-development/toc.json @@ -1,2 +1,2 @@ -{"order":100,"items":[{"name":"Data Sources Guides","href":"../data-sources/index.html","topicHref":"../data-sources/index.html","topicUid":"Guides.DataSources.Index"},{"name":"Visual Studio Code Guide","href":"../vscode/index.html","topicHref":"../vscode/index.html","topicUid":"Guides.VsCode.Index"},{"name":"WYSIWYG Guide","href":"../wysiwyg/index.html","topicHref":"../wysiwyg/index.html","topicUid":"Guides.Wysiwyg.Index"},{"name":"Common Problems","includedFrom":"~/pages/guides/app-development/common-problems/toc.yml","topicUid":"Guides.CommonProblems.Index","items":[{"name":"No Demo Item","href":"common-problems/no-demo-data/index.html","topicHref":"common-problems/no-demo-data/index.html","topicUid":"Guides.AppDevelopment.CommonProblems.NoDemoData"}]}]} +{"order":100,"items":[{"name":"Data Sources Guides","href":"../data-sources/index.html","topicHref":"../data-sources/index.html","topicUid":"Guides.DataSources.Index"},{"name":"Visual Studio Code Guide","href":"../vscode/index.html","topicHref":"../vscode/index.html","topicUid":"Guides.VsCode.Index"},{"name":"WYSIWYG Guide","href":"../wysiwyg/index.html","topicHref":"../wysiwyg/index.html","topicUid":"Guides.Wysiwyg.Index"},{"name":"Common Problems","href":"common-problems/index.html","topicHref":"common-problems/index.html","includedFrom":"~/pages/guides/app-development/common-problems/toc.yml","topicUid":"Guides.AppDevelopment.CommonProblems.Index","items":[{"name":"No Demo Item","href":"common-problems/no-demo-data/index.html","topicHref":"common-problems/no-demo-data/index.html","topicUid":"Guides.AppDevelopment.CommonProblems.NoDemoData"}]}]} diff --git a/docs/guides/toc.html b/docs/guides/toc.html index 1e52dae9b..c6ec63498 100644 --- a/docs/guides/toc.html +++ b/docs/guides/toc.html @@ -38,7 +38,7 @@
    • - Common Problems + Common Problems
      • diff --git a/docs/guides/toc.json b/docs/guides/toc.json index 60928899c..5043ead68 100644 --- a/docs/guides/toc.json +++ b/docs/guides/toc.json @@ -1,2 +1,2 @@ -{"items":[{"name":"App Design / Theming","href":"app-theme/index.html","topicHref":"app-theme/index.html","topicUid":"Guides.AppTheme.Index","items":[{"name":"App Styling v2024","href":"app-theme/styling-2024.html","topicHref":"app-theme/styling-2024.html","topicUid":"Guides.AppTheme.Styling2024"}]},{"name":"App Development","includedFrom":"~/pages/guides/app-development/toc.yml","items":[{"name":"Data Sources Guides","href":"data-sources/index.html","topicHref":"data-sources/index.html","topicUid":"Guides.DataSources.Index"},{"name":"Visual Studio Code Guide","href":"vscode/index.html","topicHref":"vscode/index.html","topicUid":"Guides.VsCode.Index"},{"name":"WYSIWYG Guide","href":"wysiwyg/index.html","topicHref":"wysiwyg/index.html","topicUid":"Guides.Wysiwyg.Index"},{"name":"Common Problems","includedFrom":"~/pages/guides/app-development/common-problems/toc.yml","topicUid":"Guides.CommonProblems.Index","items":[{"name":"No Demo Item","href":"app-development/common-problems/no-demo-data/index.html","topicHref":"app-development/common-problems/no-demo-data/index.html","topicUid":"Guides.AppDevelopment.CommonProblems.NoDemoData"}]}]},{"name":"Guides in Progress","items":[{"name":"HotBuild - ThisApp Code Guide","href":"hot-build/index.html","topicHref":"hot-build/index.html","topicUid":"Guides.HotBuild.Index"}]}]} +{"items":[{"name":"App Design / Theming","href":"app-theme/index.html","topicHref":"app-theme/index.html","topicUid":"Guides.AppTheme.Index","items":[{"name":"App Styling v2024","href":"app-theme/styling-2024.html","topicHref":"app-theme/styling-2024.html","topicUid":"Guides.AppTheme.Styling2024"}]},{"name":"App Development","includedFrom":"~/pages/guides/app-development/toc.yml","items":[{"name":"Data Sources Guides","href":"data-sources/index.html","topicHref":"data-sources/index.html","topicUid":"Guides.DataSources.Index"},{"name":"Visual Studio Code Guide","href":"vscode/index.html","topicHref":"vscode/index.html","topicUid":"Guides.VsCode.Index"},{"name":"WYSIWYG Guide","href":"wysiwyg/index.html","topicHref":"wysiwyg/index.html","topicUid":"Guides.Wysiwyg.Index"},{"name":"Common Problems","href":"app-development/common-problems/index.html","topicHref":"app-development/common-problems/index.html","includedFrom":"~/pages/guides/app-development/common-problems/toc.yml","topicUid":"Guides.AppDevelopment.CommonProblems.Index","items":[{"name":"No Demo Item","href":"app-development/common-problems/no-demo-data/index.html","topicHref":"app-development/common-problems/no-demo-data/index.html","topicUid":"Guides.AppDevelopment.CommonProblems.NoDemoData"}]}]},{"name":"Guides in Progress","items":[{"name":"HotBuild - ThisApp Code Guide","href":"hot-build/index.html","topicHref":"hot-build/index.html","topicUid":"Guides.HotBuild.Index"}]}]} diff --git a/docs/index.html b/docs/index.html index 83b045b6d..d46219710 100644 --- a/docs/index.html +++ b/docs/index.html @@ -109,7 +109,7 @@
        Table of Contents

        2sxc and EAV Docs

        -

        For version 17.06.03 LTS

        +

        For version 17.07 LTS

        This is the technical documentation for EAV and 2sxc. If you're new to 2sxc, start with 2sxc.org.

        Convert Dnn ☢️ and Oqtane 🩸 into a CMS

        2sxc is a CMS- and Meta-Plugin for Dnn/DotNetNuke and Oqtane. diff --git a/docs/index.json b/docs/index.json index 933100576..fd3c1f8cd 100644 --- a/docs/index.json +++ b/docs/index.json @@ -832,7 +832,7 @@ "api/dot-net/Custom.Data.CustomItem.html": { "href": "api/dot-net/Custom.Data.CustomItem.html", "title": "Class CustomItem | 2sxc 17 for Dnn and Oqtane", - "keywords": "Class CustomItem Namespace Custom.Data Assembly ToSic.Sxc.dll Base class for custom data objects, which are typed and can be used in Razor Components. It is used by 2sxc Copilot when generating base classes for custom data objects. [WorkInProgressApi(\"Still WIP v17.02\")] public class CustomItem : ITypedItem, ITyped, IEquatable Inheritance object CustomItem Implements ITypedItem ITyped IEquatable Remarks It's not abstract, even if the most common case is to inherit, as there are cases where you want to use it directly. Properties Guid The guid of the underlying entity. [JsonPropertyOrder(-99)] public Guid Guid { get; } Property Value Guid Remarks If the entity doesn't exist, it will return an empty guid Id The ID of the underlying entity. Use it for edit-functionality or just to have a unique number for this item. [JsonPropertyOrder(-100)] public int Id { get; } Property Value int Remarks If the entity doesn't exist, it will return 0 IsDemoItem Many templates show demo data. If the template code must know if it's the demo item or real data, use .IsDemoItem. [JsonIgnore] public bool IsDemoItem { get; } Property Value bool True if this is the item configured in the view-settings, false if not. IsPublished True if this item version is published. This means that the item can exist as published, or published-with-draft, showing the published version. Note that by default, end-users only see the published version and don't see any draft version. [JsonIgnore] public bool IsPublished { get; } Property Value bool Remarks New in v17, see also Publishing Metadata Metadata of the current item, with special features. [JsonIgnore] public IMetadata Metadata { get; } Property Value IMetadata Remarks Added in 16.02 Presentation The presentation item or null if it doesn't exist. [JsonIgnore] public ITypedItem Presentation { get; } Property Value ITypedItem Publishing [JsonIgnore] public IPublishing Publishing { get; } Property Value IPublishing Title The title of this item. This is always available no matter what the underlying field for the title is. [JsonIgnore] public string Title { get; } Property Value string The title of the underlying entity. In rare cases where no title-field is known, it can be null. It can also be null if there is no underlying entity. Remarks This returns a string which is usually what's expected. In previous versions (before v15) 2sxc it returned an object. Type The Content-Type of the current entity. [JsonIgnore] public IContentType Type { get; } Property Value IContentType _item The item - for inheriting classes to access. protected ITypedItem _item { get; } Property Value ITypedItem Remarks This property is protected, not public, as it should only be used internally. It uses an unusual name _item to avoid naming conflicts with properties generated in inheriting classes. Methods AsList(IEnumerable, NoParamOrder, bool) Convert a list of Entities or TypedItems into a strongly typed list. Typically, the type will be from your AppCode.Data. protected IEnumerable AsList(IEnumerable source, NoParamOrder protector = default, bool nullIfNull = false) where T : class, ITypedItemWrapper16, ITypedItem, new() Parameters source IEnumerable protector NoParamOrder nullIfNull bool Returns IEnumerable Type Parameters T Remarks BETA in v17.03 As(ITypedItem) Convert an Entity or TypedItem into a strongly typed object. Typically, the type will be from your AppCode.Data. protected T As(ITypedItem item) where T : class, ITypedItemWrapper16, ITypedItem, new() Parameters item ITypedItem Returns T Type Parameters T Remarks BETA in v17.03 Attribute(string, NoParamOrder, string, bool?) Return a value as a raw HTML string for using inside an attribute. Usage eg. title='@item.Attribute(\"Title\")' It will do a few things such as: Ensure dates are in the ISO format Ensure numbers are in a neutral format such as 14.27 and never 14,27 Html encode any characters which would cause trouble such as quotes public IRawHtmlString Attribute(string name, NoParamOrder noParamOrder = default, string fallback = null, bool? required = null) Parameters name string Name of the property noParamOrder NoParamOrder see Convention: Named Parameters fallback string Value to use if the property specified by name doesn't exist required bool? throw error if name doesn't exist, see Convention: Property Required Name Checks Returns IRawHtmlString Bool(string, NoParamOrder, bool, bool?) Get a property and return the value as a bool. If conversion fails, will return default false or what is specified in the fallback. public bool Bool(string name, NoParamOrder noParamOrder = default, bool fallback = false, bool? required = null) Parameters name string property name noParamOrder NoParamOrder see Convention: Named Parameters fallback bool optional fallback if conversion fails required bool? throw error if the name doesn't exist, see Convention: Property Required Name Checks Returns bool Value as bool Child(string, NoParamOrder, bool?) A single item from a field. public ITypedItem Child(string name, NoParamOrder noParamOrder = default, bool? required = null) Parameters name string Name of the field noParamOrder NoParamOrder see Convention: Named Parameters required bool? throw error if name doesn't exist, see Convention: Property Required Name Checks Returns ITypedItem The ITypedItem. If the field doesn't exist or is empty, will return null. Child(string, NoParamOrder, bool?) Get a child and return with specified custom type. public T Child(string name, NoParamOrder protector = default, bool? required = null) where T : class, ITypedItemWrapper16, ITypedItem, new() Parameters name string Name of the field protector NoParamOrder see Convention: Named Parameters required bool? throw error if name doesn't exist, see Convention: Property Required Name Checks Returns T Type Parameters T Remarks New v17.05 Children(string, NoParamOrder, string, bool?) A typed list of sub-items. Important for LINQ style querying or just working with various lists. Note that for getting child items of this item you can just use the properties, like content.Authors. But using Children(\"Authors\", type: typeName) gives you the ability to restrict to a type. Please check the tutorials on 2sxc.org/dnn-tutorials/ for more info. public IEnumerable Children(string field, NoParamOrder noParamOrder = default, string type = null, bool? required = null) Parameters field string Optional field filter - would only return items that point to the current item in a specific field name. noParamOrder NoParamOrder see Convention: Named Parameters type string Optional type filter - would only return items of this type. required bool? throw error if name doesn't exist, see Convention: Property Required Name Checks Returns IEnumerable A list of all items pointing here (filtered), converted to DynamicEntity for convenience. Remarks Note that the parameter-order is reversed to the Parents() Children(string, NoParamOrder, string, bool?) A strongly typed list of sub-items. Important for LINQ style querying or just working with various lists. Note that for getting child items of this item you can just use the properties, like content.Authors. But using Children(\"Authors\", type: typeName) gives you the ability to restrict to a type. Please check the tutorials on 2sxc.org/dnn-tutorials/ for more info. public IEnumerable Children(string field, NoParamOrder protector = default, string type = null, bool? required = null) where T : class, ITypedItemWrapper16, ITypedItem, new() Parameters field string Name of the field protector NoParamOrder see Convention: Named Parameters type string Optional type filter - would only return items of this type. required bool? throw error if name doesn't exist, see Convention: Property Required Name Checks Returns IEnumerable Type Parameters T Remarks New v17.05 ContainsKey(string) Check if this typed object has a property of this specified name. It's case-insensitive. public bool ContainsKey(string name) Parameters name string the name like Image; some objects also support path to sub-property like Author.Name Returns bool Remarks Adding in 16.03 (WIP) DateTime(string, NoParamOrder, DateTime, bool?) Get a property and return the value as a DateTime. If conversion fails, will return default 0001-01-01 or what is specified in the fallback. public DateTime DateTime(string name, NoParamOrder noParamOrder = default, DateTime fallback = default, bool? required = null) Parameters name string property name noParamOrder NoParamOrder see Convention: Named Parameters fallback DateTime optional fallback if conversion fails required bool? throw error if the name doesn't exist, see Convention: Property Required Name Checks Returns DateTime Value as DateTime Decimal(string, NoParamOrder, decimal, bool?) Get a property and return the value as a decimal. If conversion fails, will return default 0 or what is specified in the fallback. public decimal Decimal(string name, NoParamOrder noParamOrder = default, decimal fallback = 0, bool? required = null) Parameters name string property name noParamOrder NoParamOrder see Convention: Named Parameters fallback decimal optional fallback if conversion fails required bool? throw error if the name doesn't exist, see Convention: Property Required Name Checks Returns decimal Value as decimal Double(string, NoParamOrder, double, bool?) Get a property and return the value as a double. If conversion fails, will return default 0 or what is specified in the fallback. public double Double(string name, NoParamOrder noParamOrder = default, double fallback = 0, bool? required = null) Parameters name string property name noParamOrder NoParamOrder see Convention: Named Parameters fallback double optional fallback if conversion fails required bool? throw error if the name doesn't exist, see Convention: Property Required Name Checks Returns double Value as double Equals(object) Ensure that the equality check is done correctly. If two objects wrap the same item, they will be considered equal. public override bool Equals(object b) Parameters b object Returns bool Field(string, NoParamOrder, bool?) Get a special info-object describing a specific field in this item. This is a rich object used by other operations which need a lot of context about the item and the field. public IField Field(string name, NoParamOrder noParamOrder = default, bool? required = null) Parameters name string Name of the property noParamOrder NoParamOrder see Convention: Named Parameters required bool? throw error if name doesn't exist, see Convention: Property Required Name Checks Returns IField File(string, NoParamOrder, bool?) Get the file of the current field. There are a few scenarios: If it's a file/hyperlink field pointing to a file such as file:27 it will retrieve the file itself. If it's a file/hyperlink field pointing to a url such as http://xyz it will return null. If it's a library field, it will just take the first file, as there is no value referencing a specific field If it's any other field, will return null public IFile File(string name, NoParamOrder noParamOrder = default, bool? required = null) Parameters name string property name noParamOrder NoParamOrder see Convention: Named Parameters required bool? throw error if name doesn't exist, see Convention: Property Required Name Checks Returns IFile Remarks Added in 16.02 Float(string, NoParamOrder, float, bool?) Get a property and return the value as a float. If conversion fails, will return default 0 or what is specified in the fallback. public float Float(string name, NoParamOrder noParamOrder = default, float fallback = 0, bool? required = null) Parameters name string property name noParamOrder NoParamOrder see Convention: Named Parameters fallback float optional fallback if conversion fails required bool? throw error if the name doesn't exist, see Convention: Property Required Name Checks Returns float Value as float Folder(string, NoParamOrder, bool?) Get the ADAM (Automatic Digital Asset Manager) for this field. This is a folder which contains all the files and possibly folders which are uploaded on exactly this field. public IFolder Folder(string name, NoParamOrder noParamOrder = default, bool? required = null) Parameters name string property name noParamOrder NoParamOrder see Convention: Named Parameters required bool? throw error if name doesn't exist, see Convention: Property Required Name Checks Returns IFolder The Folder object Remarks Added in 16.02 Get(string, NoParamOrder, bool?) Get a property. public object Get(string name, NoParamOrder noParamOrder = default, bool? required = null) Parameters name string the property name like Image - or path to sub-property like Author.Name (new v15) noParamOrder NoParamOrder see Convention: Named Parameters required bool? throw error if name doesn't exist, see Convention: Property Required Name Checks Returns object The result if found or null; or error if the object is in strict mode Get(string, NoParamOrder, TValue, bool?) Get a value using the name - and cast it to the expected strong type. For example to get an int even though it's stored as decimal. Since the parameter fallback determines the type TValue you can just write this like `something.Get(\"Title\", fallback: \"no title\") public TValue Get(string name, NoParamOrder noParamOrder = default, TValue fallback = default, bool? required = null) Parameters name string the property name like Image - or path to sub-property like Author.Name (new v15) noParamOrder NoParamOrder see Convention: Named Parameters fallback TValue the fallback value to provide if not found required bool? throw error if name doesn't exist, see Convention: Property Required Name Checks Returns TValue The typed value, or the default like null or 0 if casting isn't possible. Type Parameters TValue The expected type, like string, int, etc. Note that you don't need to specify it, if you specify the fallback property. Remarks Added in v15 Gps(string, NoParamOrder, bool?) Get the GPS coordinates of a GPS field. public GpsCoordinates Gps(string name, NoParamOrder protector = default, bool? required = null) Parameters name string protector NoParamOrder required bool? Returns GpsCoordinates Remarks New in v17.03 Html(string, NoParamOrder, object, bool?, object, bool?, bool, Func, ITweakInput>) Show a field in the expected / best possible way. As of now it's meant for WYSIWYG fields with Very-Rich Text. See DynamicEntity / TypedItem .Html(...) Method new v16.01 public IHtmlTag Html(string name, NoParamOrder noParamOrder = default, object container = null, bool? toolbar = null, object imageSettings = null, bool? required = null, bool debug = false, Func, ITweakInput> tweak = null) Parameters name string the field name noParamOrder NoParamOrder see Convention: Named Parameters container object A wrapper tag for the result. It's either a RazorBlade tag such as Kit.HtmlTag.Div(), a string such as span or an empty string `` to indicate no container. If not set it will default to to a div-tag. See docs toolbar bool? Override default toolbar behavior on this field. See docs imageSettings object Settings for resizing. Default is Wysiwyg but it can also be Content or a settings object. required bool? throw error if name doesn't exist, see Convention: Property Required Name Checks debug bool Activate debug visualization to better see alignments and such. tweak Func, ITweakInput> tweak behavior - ATM modify the input before it's processed new in v17 Returns IHtmlTag Remarks Added in 2sxc 16.01 Added tweak in v17 Only works on Razor files inheriting from Hybrid14 or newer Img(string, NoParamOrder, object, object, object, string, string, string, object, object, object) Get a Responsive Picture object which you can then either just show, or use to construct a more customized output as you need it. The resulting object can just be added to the html, like @pic or you can work with sub-properties as specified in the IResponsivePicture. Important: This call only allows you to set the most common parameters factor and width. For other parameters like height, aspectRatio, quality etc. create typed Settings Settings(object, NoParamOrder, object, object, object, object, string, string, string, object, string, object) and pass them in. Note This is the similar as using the Picture(object, object, NoParamOrder, object, object, string, string, string, object, string, object, object, object) just a bit simpler. An important difference is that it returns null if the field does not exist or is empty, allowing you to just show nothing or use ...Picture(...) ?? someFallback; public IResponsiveImage Img(string name, NoParamOrder noParamOrder, object settings, object factor, object width, string imgAlt, string imgAltFallback, string imgClass, object imgAttributes, object toolbar, object recipe) Parameters name string Name of a field noParamOrder NoParamOrder see Convention: Named Parameters settings object The name of a settings configuration, like \"Content\", \"Screen\", \"Square\", etc. A standardized Image-Settings object like Settings.Child(\"Images.Content\") - see https://go.2sxc.org/settings A dynamic object containing settings properties (this can also be a merged custom + standard settings) A strictly typed IResizeSettings object containing all settings created using ResizeSettings factor object An optional multiplier, usually used to create urls which resize to a part of the default content-size. Eg. 0.5. width object An optional, fixed width of the image imgAlt string Optional alt attribute on the created img tag for SEO etc. If supplied, it takes precedence to the alt-description in the image metadata which the editor added themselves. If you want to provide a fallback value (in case the metadata has no alt), use imgAltFallback imgAltFallback string Optional alt attribute which is only used if the imgAlt or the alt-text in the metadata are empty. imgClass string Optional class attribute on the created img tag imgAttributes object Optional additional attributes - as anonymous object eg new { style = \"padding: 10px\" } or Dictionary (new 16.07) toolbar object Provide a custom toolbar or false to not show a toolbar recipe object Optional recipe = instructions how to create the various variants of this link. Can be any one of these: string containing variants Rule object TODO: DOCS not quite ready Returns IResponsiveImage A IResponsivePicture object which can be rendered directly. See Responsive Images API in .net If the field does not exist, it will return null If the field exists, but is empty, it will return null Remarks Added to ITypedItem in v17.04 (previously only Picture was available) Int(string, NoParamOrder, int, bool?) Get a property and return the value as a int. If conversion fails, will return default 0 or what is specified in the fallback. public int Int(string name, NoParamOrder noParamOrder = default, int fallback = 0, bool? required = null) Parameters name string property name noParamOrder NoParamOrder see Convention: Named Parameters fallback int optional fallback if conversion fails required bool? throw error if the name doesn't exist, see Convention: Property Required Name Checks Returns int Value as int IsEmpty(string, NoParamOrder) Check if this typed object has a property of this specified name, and has real data. The opposite version of this is IsNotEmpty(...) Important This method is optimized for use in Razor-like scenarios. It's behavior is super-useful but maybe not always expected. If the value is a string, and is empty or only contains whitespace (even  ) it is regarded as empty. If the returned value is an empty list (eg. a field containing relationships, without any items in it) it is regarded as empty. If you need a different kind of check, just .Get(...) the value and perform the checks in your code. public bool IsEmpty(string name, NoParamOrder noParamOrder = default) Parameters name string the property name like Image; some objects also support path to sub-property like Author.Name noParamOrder NoParamOrder see Convention: Named Parameters Returns bool true if the property exists and has a real value. If it would return an empty list, it will also return false Remarks Adding in 16.03 (WIP) IsNotEmpty(string, NoParamOrder) Check if this typed object has a property of this specified name, and has real data. The opposite version of this is IsEmpty(...) Important This method is optimized for use in Razor-like scenarios. It's behavior is super-useful but maybe not always expected. If the value is a string, and is empty or only contains whitespace (even  ) it is regarded as empty. If the returned value is an empty list (eg. a field containing relationships, without any items in it) it is regarded as empty. If you need a different kind of check, just .Get(...) the value and perform the checks in your code. public bool IsNotEmpty(string name, NoParamOrder noParamOrder = default) Parameters name string the property name like Image; some objects also support path to sub-property like Author.Name noParamOrder NoParamOrder see Convention: Named Parameters Returns bool true if the property exists and has a real value. If it would return an empty list, it will also return false Remarks Adding in 16.03 (WIP) Keys(NoParamOrder, IEnumerable) Get all the keys available in this Model (all the parameters passed in). This is used to sometimes run early checks if all the expected parameters have been provided. public IEnumerable Keys(NoParamOrder noParamOrder = default, IEnumerable only = null) Parameters noParamOrder NoParamOrder see Convention: Named Parameters only IEnumerable Only return the keys specified here, if found. Typical use: only: new [] { \"Key1\", \"Key2\" }. Useful to check if all or any specific keys exist. Returns IEnumerable Remarks Added in 16.03 Long(string, NoParamOrder, long, bool?) Get a property and return the value as a long. If conversion fails, will return default 0 or what is specified in the fallback. public long Long(string name, NoParamOrder noParamOrder = default, long fallback = 0, bool? required = null) Parameters name string property name noParamOrder NoParamOrder see Convention: Named Parameters fallback long optional fallback if conversion fails required bool? throw error if the name doesn't exist, see Convention: Property Required Name Checks Returns long Value as long Parent(NoParamOrder, bool?, string, string) Get either the current parent or the first parent which would be found on .Parents(...). public ITypedItem Parent(NoParamOrder noParamOrder = default, bool? current = null, string type = null, string field = null) Parameters noParamOrder NoParamOrder see Convention: Named Parameters current bool? if set to true, will get the Item which created the current item (the parent) which called .Child(...) or .Children(...) type string Optional type filter - would only return items of this type. field string Optional field filter - would only return items that point to the current item in a specific field name. Returns ITypedItem either the current parent or the first parent returned by the same .Parents(...) call. Parent(NoParamOrder, bool?, string, string) Get either the current parent or the first parent which would be found on .Parents(...) as strongly typed. public T Parent(NoParamOrder protector = default, bool? current = null, string type = null, string field = null) where T : class, ITypedItemWrapper16, ITypedItem, new() Parameters protector NoParamOrder see Convention: Named Parameters current bool? if set to true, will get the Item which created the current item (the parent) which called .Child(...) or .Children(...) type string Optional type filter - would only return items of this type. field string Optional field filter - would only return items that point to the current item in a specific field name. Returns T either the current parent or the first parent returned by the same .Parents(...) call. Type Parameters T Remarks New v17.06 Parents(NoParamOrder, string, string) A typed list of entities which point to this item. Important for LINQ style querying or just working with various lists. Note that for getting child items of this item you can just use the properties, like content.Authors. Please check the tutorials on 2sxc.org/dnn-tutorials/ for more info. public IEnumerable Parents(NoParamOrder noParamOrder = default, string type = null, string field = null) Parameters noParamOrder NoParamOrder see Convention: Named Parameters type string Optional type filter - would only return items of this type. field string Optional field filter - would only return items that point to the current item in a specific field name. Returns IEnumerable A list of all items pointing here (filtered), converted to DynamicEntity for convenience. Remarks Note that the parameter-order is reversed to the Children() Parents(NoParamOrder, string, string) A typed list of entities which point to this item. Important for LINQ style querying or just working with various lists. Note that for getting child items of this item you can just use the properties, like content.Authors. Please check the tutorials on 2sxc.org/dnn-tutorials/ for more info. public IEnumerable Parents(NoParamOrder protector = default, string type = null, string field = null) where T : class, ITypedItemWrapper16, ITypedItem, new() Parameters protector NoParamOrder see Convention: Named Parameters type string Optional type filter - would only return items of this type. If not specified (null) will use the name of T. field string Optional field filter - would only return items that point to the current item in a specific field name. Returns IEnumerable A list of all items pointing here (filtered), converted to DynamicEntity for convenience. Type Parameters T Remarks Note that the parameter-order is reversed to the Children() Picture(string, NoParamOrder, object, object, object, string, string, string, object, string, object, object, object) Get a Responsive Picture object which you can then either just show, or use to construct a more customized output as you need it. The resulting object can just be added to the html, like @pic or you can work with sub-properties as specified in the IResponsivePicture. Important: This call only allows you to set the most common parameters factor and width. For other parameters like height, aspectRatio, quality etc. create typed Settings Settings(object, NoParamOrder, object, object, object, object, string, string, string, object, string, object) and pass them in. Note This is the similar as using the Picture(object, object, NoParamOrder, object, object, string, string, string, object, string, object, object, object) just a bit simpler. An important difference is that it returns null if the field does not exist or is empty, allowing you to just show nothing or use ...Picture(...) ?? someFallback; public IResponsivePicture Picture(string name, NoParamOrder noParamOrder = default, object settings = null, object factor = null, object width = null, string imgAlt = null, string imgAltFallback = null, string imgClass = null, object imgAttributes = null, string pictureClass = null, object pictureAttributes = null, object toolbar = null, object recipe = null) Parameters name string Name of a field noParamOrder NoParamOrder see Convention: Named Parameters settings object The name of a settings configuration, like \"Content\", \"Screen\", \"Square\", etc. A standardized Image-Settings object like Settings.Child(\"Images.Content\") - see https://go.2sxc.org/settings A dynamic object containing settings properties (this can also be a merged custom + standard settings) A strictly typed IResizeSettings object containing all settings created using ResizeSettings factor object An optional multiplier, usually used to create urls which resize to a part of the default content-size. Eg. 0.5. width object An optional, fixed width of the image imgAlt string Optional alt attribute on the created img tag for SEO etc. If supplied, it takes precedence to the alt-description in the image metadata which the editor added themselves. If you want to provide a fallback value (in case the metadata has no alt), use imgAltFallback imgAltFallback string Optional alt attribute which is only used if the imgAlt or the alt-text in the metadata are empty. imgClass string Optional class attribute on the created img tag imgAttributes object Optional additional attributes - as anonymous object eg new { style = \"padding: 10px\" } or Dictionary (new 16.07) pictureClass string Optional class attribute on the created picture tag pictureAttributes object Optional additional attributes - as anonymous object eg new { style = \"padding: 10px\" } or Dictionary (new 16.07) toolbar object Provide a custom toolbar or false to not show a toolbar recipe object Optional recipe = instructions how to create the various variants of this link. Can be any one of these: string containing variants Rule object TODO: DOCS not quite ready Returns IResponsivePicture A IResponsivePicture object which can be rendered directly. See Responsive Images API in .net If the field does not exist, it will return null If the field exists, but is empty, it will return null Remarks Added to ITypedItem in v16.03 imgAttributes, picClass and picAttributes added in 16.07 String(string, NoParamOrder, string, bool?, object) Get a property and return the value as a string. If conversion fails, will return default null or what is specified in the fallback. public string String(string name, NoParamOrder noParamOrder = default, string fallback = null, bool? required = null, object scrubHtml = null) Parameters name string property name noParamOrder NoParamOrder see Convention: Named Parameters fallback string optional fallback if conversion fails required bool? throw error if the name doesn't exist, see Convention: Property Required Name Checks scrubHtml object If true, will remove all HTML tags from the string. If p will remove all p tags, if div,span will remove these tags. This is the same as using Kit.Scrub.All(...) or .Only(...). For more detailed scrubbing, use the Kit.Scrub` Returns string Value as string ToString() Override ToString to give more information about the current object public override string ToString() Returns string Url(string, NoParamOrder, string, bool?) Get a url from a field. It will do sanitation / url-corrections for special characters etc. On TypedItems it will also auto-convert values such as file:72 or page:14. public string Url(string name, NoParamOrder noParamOrder = default, string fallback = null, bool? required = null) Parameters name string The field name. noParamOrder NoParamOrder see Convention: Named Parameters fallback string optional fallback if conversion fails required bool? throw error if the name doesn't exist, see Convention: Property Required Name Checks Returns string A url converted if possible. If the field contains anything else such as hello then it will not be modified. Operators operator ==(CustomItem, CustomItem) Ensure that the equality check is done correctly. If two objects wrap the same item, they will be considered equal. public static bool operator ==(CustomItem item1, CustomItem item2) Parameters item1 CustomItem first item to compare item2 CustomItem second item to compare Returns bool true, if both wrappers are the same type and wrap the same entity operator !=(CustomItem, CustomItem) Ensure that the equality check is done correctly. If two objects wrap the same item, they will be considered equal. public static bool operator !=(CustomItem item1, CustomItem item2) Parameters item1 CustomItem first item to compare item2 CustomItem second item to compare Returns bool false, if both wrappers are the same type and wrap the same entity" + "keywords": "Class CustomItem Namespace Custom.Data Assembly ToSic.Sxc.dll Base class for custom data objects, which are typed and can be used in Razor Components. It is used by 2sxc Copilot when generating base classes for custom data objects. [PublicApi] public class CustomItem : ITypedItem, ITyped, IEquatable Inheritance object CustomItem Implements ITypedItem ITyped IEquatable Remarks Released in v17.06 It's not abstract, even if the most common case is to inherit, as there are cases where you want to use it directly. Properties Guid The guid of the underlying entity. [JsonPropertyOrder(-99)] public Guid Guid { get; } Property Value Guid Remarks If the entity doesn't exist, it will return an empty guid Id The ID of the underlying entity. Use it for edit-functionality or just to have a unique number for this item. [JsonPropertyOrder(-100)] public int Id { get; } Property Value int Remarks If the entity doesn't exist, it will return 0 IsDemoItem Many templates show demo data. If the template code must know if it's the demo item or real data, use .IsDemoItem. [JsonIgnore] public bool IsDemoItem { get; } Property Value bool True if this is the item configured in the view-settings, false if not. IsPublished True if this item version is published. This means that the item can exist as published, or published-with-draft, showing the published version. Note that by default, end-users only see the published version and don't see any draft version. [JsonIgnore] public bool IsPublished { get; } Property Value bool Remarks New in v17, see also Publishing Metadata Metadata of the current item, with special features. [JsonIgnore] public IMetadata Metadata { get; } Property Value IMetadata Remarks Added in 16.02 Presentation The presentation item or null if it doesn't exist. [JsonIgnore] public ITypedItem Presentation { get; } Property Value ITypedItem Publishing [JsonIgnore] public IPublishing Publishing { get; } Property Value IPublishing Title The title of this item. This is always available no matter what the underlying field for the title is. [JsonIgnore] public string Title { get; } Property Value string The title of the underlying entity. In rare cases where no title-field is known, it can be null. It can also be null if there is no underlying entity. Remarks This returns a string which is usually what's expected. In previous versions (before v15) 2sxc it returned an object. Type The Content-Type of the current entity. [JsonIgnore] public IContentType Type { get; } Property Value IContentType _item The item - for inheriting classes to access. protected ITypedItem _item { get; } Property Value ITypedItem Remarks This property is protected, not public, as it should only be used internally. It uses an unusual name _item to avoid naming conflicts with properties generated in inheriting classes. Methods AsList(IEnumerable, NoParamOrder, bool) Convert a list of Entities or TypedItems into a strongly typed list. Typically, the type will be from your AppCode.Data. protected IEnumerable AsList(IEnumerable source, NoParamOrder protector = default, bool nullIfNull = false) where T : class, ITypedItemWrapper16, ITypedItem, new() Parameters source IEnumerable protector NoParamOrder nullIfNull bool Returns IEnumerable Type Parameters T Remarks BETA in v17.03 As(ITypedItem) Convert an Entity or TypedItem into a strongly typed object. Typically, the type will be from your AppCode.Data. protected T As(ITypedItem item) where T : class, ITypedItemWrapper16, ITypedItem, new() Parameters item ITypedItem Returns T Type Parameters T Remarks BETA in v17.03 Attribute(string, NoParamOrder, string, bool?) Return a value as a raw HTML string for using inside an attribute. Usage eg. title='@item.Attribute(\"Title\")' It will do a few things such as: Ensure dates are in the ISO format Ensure numbers are in a neutral format such as 14.27 and never 14,27 Html encode any characters which would cause trouble such as quotes public IRawHtmlString Attribute(string name, NoParamOrder noParamOrder = default, string fallback = null, bool? required = null) Parameters name string Name of the property noParamOrder NoParamOrder see Convention: Named Parameters fallback string Value to use if the property specified by name doesn't exist required bool? throw error if name doesn't exist, see Convention: Property Required Name Checks Returns IRawHtmlString Bool(string, NoParamOrder, bool, bool?) Get a property and return the value as a bool. If conversion fails, will return default false or what is specified in the fallback. public bool Bool(string name, NoParamOrder noParamOrder = default, bool fallback = false, bool? required = null) Parameters name string property name noParamOrder NoParamOrder see Convention: Named Parameters fallback bool optional fallback if conversion fails required bool? throw error if the name doesn't exist, see Convention: Property Required Name Checks Returns bool Value as bool Child(string, NoParamOrder, bool?) A single item from a field. public ITypedItem Child(string name, NoParamOrder noParamOrder = default, bool? required = null) Parameters name string Name of the field noParamOrder NoParamOrder see Convention: Named Parameters required bool? throw error if name doesn't exist, see Convention: Property Required Name Checks Returns ITypedItem The ITypedItem. If the field doesn't exist or is empty, will return null. Child(string, NoParamOrder, bool?) Get a child and return with specified custom type. public T Child(string name, NoParamOrder protector = default, bool? required = null) where T : class, ITypedItemWrapper16, ITypedItem, new() Parameters name string Name of the field protector NoParamOrder see Convention: Named Parameters required bool? throw error if name doesn't exist, see Convention: Property Required Name Checks Returns T Type Parameters T Remarks New v17.05 Children(string, NoParamOrder, string, bool?) A typed list of sub-items. Important for LINQ style querying or just working with various lists. Note that for getting child items of this item you can just use the properties, like content.Authors. But using Children(\"Authors\", type: typeName) gives you the ability to restrict to a type. Please check the tutorials on 2sxc.org/dnn-tutorials/ for more info. public IEnumerable Children(string field, NoParamOrder noParamOrder = default, string type = null, bool? required = null) Parameters field string Optional field filter - would only return items that point to the current item in a specific field name. noParamOrder NoParamOrder see Convention: Named Parameters type string Optional type filter - would only return items of this type. required bool? throw error if name doesn't exist, see Convention: Property Required Name Checks Returns IEnumerable A list of all items pointing here (filtered), converted to DynamicEntity for convenience. Remarks Note that the parameter-order is reversed to the Parents() Children(string, NoParamOrder, string, bool?) A strongly typed list of sub-items. Important for LINQ style querying or just working with various lists. Note that for getting child items of this item you can just use the properties, like content.Authors. But using Children(\"Authors\", type: typeName) gives you the ability to restrict to a type. Please check the tutorials on 2sxc.org/dnn-tutorials/ for more info. public IEnumerable Children(string field, NoParamOrder protector = default, string type = null, bool? required = null) where T : class, ITypedItemWrapper16, ITypedItem, new() Parameters field string Name of the field protector NoParamOrder see Convention: Named Parameters type string Optional type filter - would only return items of this type. required bool? throw error if name doesn't exist, see Convention: Property Required Name Checks Returns IEnumerable Type Parameters T Remarks New v17.05 ContainsKey(string) Check if this typed object has a property of this specified name. It's case-insensitive. public bool ContainsKey(string name) Parameters name string the name like Image; some objects also support path to sub-property like Author.Name Returns bool Remarks Adding in 16.03 (WIP) DateTime(string, NoParamOrder, DateTime, bool?) Get a property and return the value as a DateTime. If conversion fails, will return default 0001-01-01 or what is specified in the fallback. public DateTime DateTime(string name, NoParamOrder noParamOrder = default, DateTime fallback = default, bool? required = null) Parameters name string property name noParamOrder NoParamOrder see Convention: Named Parameters fallback DateTime optional fallback if conversion fails required bool? throw error if the name doesn't exist, see Convention: Property Required Name Checks Returns DateTime Value as DateTime Decimal(string, NoParamOrder, decimal, bool?) Get a property and return the value as a decimal. If conversion fails, will return default 0 or what is specified in the fallback. public decimal Decimal(string name, NoParamOrder noParamOrder = default, decimal fallback = 0, bool? required = null) Parameters name string property name noParamOrder NoParamOrder see Convention: Named Parameters fallback decimal optional fallback if conversion fails required bool? throw error if the name doesn't exist, see Convention: Property Required Name Checks Returns decimal Value as decimal Double(string, NoParamOrder, double, bool?) Get a property and return the value as a double. If conversion fails, will return default 0 or what is specified in the fallback. public double Double(string name, NoParamOrder noParamOrder = default, double fallback = 0, bool? required = null) Parameters name string property name noParamOrder NoParamOrder see Convention: Named Parameters fallback double optional fallback if conversion fails required bool? throw error if the name doesn't exist, see Convention: Property Required Name Checks Returns double Value as double Equals(object) Ensure that the equality check is done correctly. If two objects wrap the same item, they will be considered equal. public override bool Equals(object b) Parameters b object Returns bool Field(string, NoParamOrder, bool?) Get a special info-object describing a specific field in this item. This is a rich object used by other operations which need a lot of context about the item and the field. public IField Field(string name, NoParamOrder noParamOrder = default, bool? required = null) Parameters name string Name of the property noParamOrder NoParamOrder see Convention: Named Parameters required bool? throw error if name doesn't exist, see Convention: Property Required Name Checks Returns IField File(string, NoParamOrder, bool?) Get the file of the current field. There are a few scenarios: If it's a file/hyperlink field pointing to a file such as file:27 it will retrieve the file itself. If it's a file/hyperlink field pointing to a url such as http://xyz it will return null. If it's a library field, it will just take the first file, as there is no value referencing a specific field If it's any other field, will return null public IFile File(string name, NoParamOrder noParamOrder = default, bool? required = null) Parameters name string property name noParamOrder NoParamOrder see Convention: Named Parameters required bool? throw error if name doesn't exist, see Convention: Property Required Name Checks Returns IFile Remarks Added in 16.02 Float(string, NoParamOrder, float, bool?) Get a property and return the value as a float. If conversion fails, will return default 0 or what is specified in the fallback. public float Float(string name, NoParamOrder noParamOrder = default, float fallback = 0, bool? required = null) Parameters name string property name noParamOrder NoParamOrder see Convention: Named Parameters fallback float optional fallback if conversion fails required bool? throw error if the name doesn't exist, see Convention: Property Required Name Checks Returns float Value as float Folder(string, NoParamOrder, bool?) Get the ADAM (Automatic Digital Asset Manager) for this field. This is a folder which contains all the files and possibly folders which are uploaded on exactly this field. public IFolder Folder(string name, NoParamOrder noParamOrder = default, bool? required = null) Parameters name string property name noParamOrder NoParamOrder see Convention: Named Parameters required bool? throw error if name doesn't exist, see Convention: Property Required Name Checks Returns IFolder The Folder object Remarks Added in 16.02 Get(string, NoParamOrder, bool?) Get a property. public object Get(string name, NoParamOrder noParamOrder = default, bool? required = null) Parameters name string the property name like Image - or path to sub-property like Author.Name (new v15) noParamOrder NoParamOrder see Convention: Named Parameters required bool? throw error if name doesn't exist, see Convention: Property Required Name Checks Returns object The result if found or null; or error if the object is in strict mode Get(string, NoParamOrder, TValue, bool?) Get a value using the name - and cast it to the expected strong type. For example to get an int even though it's stored as decimal. Since the parameter fallback determines the type TValue you can just write this like `something.Get(\"Title\", fallback: \"no title\") public TValue Get(string name, NoParamOrder noParamOrder = default, TValue fallback = default, bool? required = null) Parameters name string the property name like Image - or path to sub-property like Author.Name (new v15) noParamOrder NoParamOrder see Convention: Named Parameters fallback TValue the fallback value to provide if not found required bool? throw error if name doesn't exist, see Convention: Property Required Name Checks Returns TValue The typed value, or the default like null or 0 if casting isn't possible. Type Parameters TValue The expected type, like string, int, etc. Note that you don't need to specify it, if you specify the fallback property. Remarks Added in v15 Gps(string, NoParamOrder, bool?) Get the GPS coordinates of a GPS field as a typed object. public GpsCoordinates Gps(string name, NoParamOrder protector = default, bool? required = null) Parameters name string Name of a field protector NoParamOrder see Convention: Named Parameters required bool? throw error if name doesn't exist, see Convention: Property Required Name Checks Returns GpsCoordinates Remarks New in v17.03 Html(string, NoParamOrder, object, bool?, object, bool?, bool, Func, ITweakInput>) Show a field in the expected / best possible way. As of now it's meant for WYSIWYG fields with Very-Rich Text. See DynamicEntity / TypedItem .Html(...) Method new v16.01 public IHtmlTag Html(string name, NoParamOrder noParamOrder = default, object container = null, bool? toolbar = null, object imageSettings = null, bool? required = null, bool debug = false, Func, ITweakInput> tweak = null) Parameters name string the field name noParamOrder NoParamOrder see Convention: Named Parameters container object A wrapper tag for the result. It's either a RazorBlade tag such as Kit.HtmlTag.Div(), a string such as span or an empty string `` to indicate no container. If not set it will default to to a div-tag. See docs toolbar bool? Override default toolbar behavior on this field. See docs imageSettings object Settings for resizing. Default is Wysiwyg but it can also be Content or a settings object. required bool? throw error if name doesn't exist, see Convention: Property Required Name Checks debug bool Activate debug visualization to better see alignments and such. tweak Func, ITweakInput> tweak behavior - ATM modify the input before it's processed new in v17 Returns IHtmlTag Remarks Added in 2sxc 16.01 Added tweak in v17 Only works on Razor files inheriting from Hybrid14 or newer Img(string, NoParamOrder, object, object, object, string, string, string, object, object, object) Get a Responsive Picture object which you can then either just show, or use to construct a more customized output as you need it. The resulting object can just be added to the html, like @pic or you can work with sub-properties as specified in the IResponsivePicture. Important: This call only allows you to set the most common parameters factor and width. For other parameters like height, aspectRatio, quality etc. create typed Settings Settings(object, NoParamOrder, object, object, object, object, string, string, string, object, string, object) and pass them in. Note This is the similar as using the Picture(object, object, NoParamOrder, object, object, string, string, string, object, string, object, object, object) just a bit simpler. An important difference is that it returns null if the field does not exist or is empty, allowing you to just show nothing or use ...Picture(...) ?? someFallback; public IResponsiveImage Img(string name, NoParamOrder noParamOrder = default, object settings = null, object factor = null, object width = null, string imgAlt = null, string imgAltFallback = null, string imgClass = null, object imgAttributes = null, object toolbar = null, object recipe = null) Parameters name string Name of a field noParamOrder NoParamOrder see Convention: Named Parameters settings object The name of a settings configuration, like \"Content\", \"Screen\", \"Square\", etc. A standardized Image-Settings object like Settings.Child(\"Images.Content\") - see https://go.2sxc.org/settings A dynamic object containing settings properties (this can also be a merged custom + standard settings) A strictly typed IResizeSettings object containing all settings created using ResizeSettings factor object An optional multiplier, usually used to create urls which resize to a part of the default content-size. Eg. 0.5. width object An optional, fixed width of the image imgAlt string Optional alt attribute on the created img tag for SEO etc. If supplied, it takes precedence to the alt-description in the image metadata which the editor added themselves. If you want to provide a fallback value (in case the metadata has no alt), use imgAltFallback imgAltFallback string Optional alt attribute which is only used if the imgAlt or the alt-text in the metadata are empty. imgClass string Optional class attribute on the created img tag imgAttributes object Optional additional attributes - as anonymous object eg new { style = \"padding: 10px\" } or Dictionary (new 16.07) toolbar object Provide a custom toolbar or false to not show a toolbar recipe object Optional recipe = instructions how to create the various variants of this link. Can be any one of these: string containing variants Rule object TODO: DOCS not quite ready Returns IResponsiveImage A IResponsivePicture object which can be rendered directly. See Responsive Images API in .net If the field does not exist, it will return null If the field exists, but is empty, it will return null Remarks Added to ITypedItem in v17.04 (previously only Picture was available) Int(string, NoParamOrder, int, bool?) Get a property and return the value as a int. If conversion fails, will return default 0 or what is specified in the fallback. public int Int(string name, NoParamOrder noParamOrder = default, int fallback = 0, bool? required = null) Parameters name string property name noParamOrder NoParamOrder see Convention: Named Parameters fallback int optional fallback if conversion fails required bool? throw error if the name doesn't exist, see Convention: Property Required Name Checks Returns int Value as int IsEmpty(string, NoParamOrder) Check if this typed object has a property of this specified name, and has real data. The opposite version of this is IsNotEmpty(...) Important This method is optimized for use in Razor-like scenarios. It's behavior is super-useful but maybe not always expected. If the value is a string, and is empty or only contains whitespace (even  ) it is regarded as empty. If the returned value is an empty list (eg. a field containing relationships, without any items in it) it is regarded as empty. If you need a different kind of check, just .Get(...) the value and perform the checks in your code. public bool IsEmpty(string name, NoParamOrder noParamOrder = default) Parameters name string the property name like Image; some objects also support path to sub-property like Author.Name noParamOrder NoParamOrder see Convention: Named Parameters Returns bool true if the property exists and has a real value. If it would return an empty list, it will also return false Remarks Adding in 16.03 (WIP) IsNotEmpty(string, NoParamOrder) Check if this typed object has a property of this specified name, and has real data. The opposite version of this is IsEmpty(...) Important This method is optimized for use in Razor-like scenarios. It's behavior is super-useful but maybe not always expected. If the value is a string, and is empty or only contains whitespace (even  ) it is regarded as empty. If the returned value is an empty list (eg. a field containing relationships, without any items in it) it is regarded as empty. If you need a different kind of check, just .Get(...) the value and perform the checks in your code. public bool IsNotEmpty(string name, NoParamOrder noParamOrder = default) Parameters name string the property name like Image; some objects also support path to sub-property like Author.Name noParamOrder NoParamOrder see Convention: Named Parameters Returns bool true if the property exists and has a real value. If it would return an empty list, it will also return false Remarks Adding in 16.03 (WIP) Keys(NoParamOrder, IEnumerable) Get all the keys available in this Model (all the parameters passed in). This is used to sometimes run early checks if all the expected parameters have been provided. public IEnumerable Keys(NoParamOrder noParamOrder = default, IEnumerable only = null) Parameters noParamOrder NoParamOrder see Convention: Named Parameters only IEnumerable Only return the keys specified here, if found. Typical use: only: new [] { \"Key1\", \"Key2\" }. Useful to check if all or any specific keys exist. Returns IEnumerable Remarks Added in 16.03 Long(string, NoParamOrder, long, bool?) Get a property and return the value as a long. If conversion fails, will return default 0 or what is specified in the fallback. public long Long(string name, NoParamOrder noParamOrder = default, long fallback = 0, bool? required = null) Parameters name string property name noParamOrder NoParamOrder see Convention: Named Parameters fallback long optional fallback if conversion fails required bool? throw error if the name doesn't exist, see Convention: Property Required Name Checks Returns long Value as long Parent(NoParamOrder, bool?, string, string) Get either the current parent or the first parent which would be found on .Parents(...). public ITypedItem Parent(NoParamOrder noParamOrder = default, bool? current = null, string type = null, string field = null) Parameters noParamOrder NoParamOrder see Convention: Named Parameters current bool? if set to true, will get the Item which created the current item (the parent) which called .Child(...) or .Children(...) type string Optional type filter - would only return items of this type. field string Optional field filter - would only return items that point to the current item in a specific field name. Returns ITypedItem either the current parent or the first parent returned by the same .Parents(...) call. Parent(NoParamOrder, bool?, string, string) Get either the current parent or the first parent which would be found on .Parents(...) as strongly typed. public T Parent(NoParamOrder protector = default, bool? current = null, string type = null, string field = null) where T : class, ITypedItemWrapper16, ITypedItem, new() Parameters protector NoParamOrder see Convention: Named Parameters current bool? if set to true, will get the Item which created the current item (the parent) which called .Child(...) or .Children(...) type string Optional type filter - would only return items of this type. field string Optional field filter - would only return items that point to the current item in a specific field name. Returns T either the current parent or the first parent returned by the same .Parents(...) call. Type Parameters T Remarks New v17.06 Parents(NoParamOrder, string, string) A typed list of entities which point to this item. Important for LINQ style querying or just working with various lists. Note that for getting child items of this item you can just use the properties, like content.Authors. Please check the tutorials on 2sxc.org/dnn-tutorials/ for more info. public IEnumerable Parents(NoParamOrder noParamOrder = default, string type = null, string field = null) Parameters noParamOrder NoParamOrder see Convention: Named Parameters type string Optional type filter - would only return items of this type. field string Optional field filter - would only return items that point to the current item in a specific field name. Returns IEnumerable A list of all items pointing here (filtered), converted to DynamicEntity for convenience. Remarks Note that the parameter-order is reversed to the Children() Parents(NoParamOrder, string, string) A typed list of entities which point to this item. Important for LINQ style querying or just working with various lists. Note that for getting child items of this item you can just use the properties, like content.Authors. Please check the tutorials on 2sxc.org/dnn-tutorials/ for more info. public IEnumerable Parents(NoParamOrder protector = default, string type = null, string field = null) where T : class, ITypedItemWrapper16, ITypedItem, new() Parameters protector NoParamOrder see Convention: Named Parameters type string Optional type filter - would only return items of this type. If not specified (null) will use the name of T. field string Optional field filter - would only return items that point to the current item in a specific field name. Returns IEnumerable A list of all items pointing here (filtered), converted to DynamicEntity for convenience. Type Parameters T Remarks Note that the parameter-order is reversed to the Children() Picture(string, NoParamOrder, object, object, object, string, string, string, object, string, object, object, object) Get a Responsive Picture object which you can then either just show, or use to construct a more customized output as you need it. The resulting object can just be added to the html, like @pic or you can work with sub-properties as specified in the IResponsivePicture. Important: This call only allows you to set the most common parameters factor and width. For other parameters like height, aspectRatio, quality etc. create typed Settings Settings(object, NoParamOrder, object, object, object, object, string, string, string, object, string, object) and pass them in. Note This is the similar as using the Picture(object, object, NoParamOrder, object, object, string, string, string, object, string, object, object, object) just a bit simpler. An important difference is that it returns null if the field does not exist or is empty, allowing you to just show nothing or use ...Picture(...) ?? someFallback; public IResponsivePicture Picture(string name, NoParamOrder noParamOrder = default, object settings = null, object factor = null, object width = null, string imgAlt = null, string imgAltFallback = null, string imgClass = null, object imgAttributes = null, string pictureClass = null, object pictureAttributes = null, object toolbar = null, object recipe = null) Parameters name string Name of a field noParamOrder NoParamOrder see Convention: Named Parameters settings object The name of a settings configuration, like \"Content\", \"Screen\", \"Square\", etc. A standardized Image-Settings object like Settings.Child(\"Images.Content\") - see https://go.2sxc.org/settings A dynamic object containing settings properties (this can also be a merged custom + standard settings) A strictly typed IResizeSettings object containing all settings created using ResizeSettings factor object An optional multiplier, usually used to create urls which resize to a part of the default content-size. Eg. 0.5. width object An optional, fixed width of the image imgAlt string Optional alt attribute on the created img tag for SEO etc. If supplied, it takes precedence to the alt-description in the image metadata which the editor added themselves. If you want to provide a fallback value (in case the metadata has no alt), use imgAltFallback imgAltFallback string Optional alt attribute which is only used if the imgAlt or the alt-text in the metadata are empty. imgClass string Optional class attribute on the created img tag imgAttributes object Optional additional attributes - as anonymous object eg new { style = \"padding: 10px\" } or Dictionary (new 16.07) pictureClass string Optional class attribute on the created picture tag pictureAttributes object Optional additional attributes - as anonymous object eg new { style = \"padding: 10px\" } or Dictionary (new 16.07) toolbar object Provide a custom toolbar or false to not show a toolbar recipe object Optional recipe = instructions how to create the various variants of this link. Can be any one of these: string containing variants Rule object TODO: DOCS not quite ready Returns IResponsivePicture A IResponsivePicture object which can be rendered directly. See Responsive Images API in .net If the field does not exist, it will return null If the field exists, but is empty, it will return null Remarks Added to ITypedItem in v16.03 imgAttributes, picClass and picAttributes added in 16.07 String(string, NoParamOrder, string, bool?, object) Get a property and return the value as a string. If conversion fails, will return default null or what is specified in the fallback. public string String(string name, NoParamOrder noParamOrder = default, string fallback = null, bool? required = null, object scrubHtml = null) Parameters name string property name noParamOrder NoParamOrder see Convention: Named Parameters fallback string optional fallback if conversion fails required bool? throw error if the name doesn't exist, see Convention: Property Required Name Checks scrubHtml object If true, will remove all HTML tags from the string. If p will remove all p tags, if div,span will remove these tags. This is the same as using Kit.Scrub.All(...) or .Only(...). For more detailed scrubbing, use the Kit.Scrub` Returns string Value as string ToString() Override ToString to give more information about the current object public override string ToString() Returns string Url(string, NoParamOrder, string, bool?) Get a url from a field. It will do sanitation / url-corrections for special characters etc. On TypedItems it will also auto-convert values such as file:72 or page:14. public string Url(string name, NoParamOrder noParamOrder = default, string fallback = null, bool? required = null) Parameters name string The field name. noParamOrder NoParamOrder see Convention: Named Parameters fallback string optional fallback if conversion fails required bool? throw error if the name doesn't exist, see Convention: Property Required Name Checks Returns string A url converted if possible. If the field contains anything else such as hello then it will not be modified. Operators operator ==(CustomItem, CustomItem) Ensure that the equality check is done correctly. If two objects wrap the same item, they will be considered equal. public static bool operator ==(CustomItem item1, CustomItem item2) Parameters item1 CustomItem first item to compare item2 CustomItem second item to compare Returns bool true, if both wrappers are the same type and wrap the same entity operator !=(CustomItem, CustomItem) Ensure that the equality check is done correctly. If two objects wrap the same item, they will be considered equal. public static bool operator !=(CustomItem item1, CustomItem item2) Parameters item1 CustomItem first item to compare item2 CustomItem second item to compare Returns bool false, if both wrappers are the same type and wrap the same entity" }, "api/dot-net/Custom.Data.html": { "href": "api/dot-net/Custom.Data.html", @@ -882,7 +882,7 @@ "api/dot-net/Custom.Hybrid.ApiTyped.html": { "href": "api/dot-net/Custom.Hybrid.ApiTyped.html", "title": "Class ApiTyped | 2sxc 17 for Dnn and Oqtane", - "keywords": "Class ApiTyped Namespace Custom.Hybrid Assembly ToSic.Sxc.Dnn.WebApi.dll Base class for v16 Typed WebAPI files. Use it to create custom WebAPI endpoints in your App. It provides the ServiceKit16 on property Kit which contains all the popular services to create amazing stuff. [PublicApi] [JsonFormatter] public abstract class ApiTyped : DnnSxcCustomControllerBase, IHasLog Inheritance object ApiController DnnApiController DnnSxcControllerRoot DnnSxcControllerBase DnnSxcCustomControllerBase ApiTyped Implements IHasLog Remarks Important: This is very different from Razor12 or Razor14, as it doesn't rely on dynamic code. Be aware of this since the APIs are very different - see Typed Code. Constructors ApiTyped() Main constructor. Doesn't have parameters so it can easily be inherited. protected ApiTyped() ApiTyped(string) Alternate constructor to use when inheriting, placing the Insights logs in an own section. protected ApiTyped(string insightsGroup) Parameters insightsGroup string Name of the section in Insights Properties AllResources Stack of all Resources in the System, merging Resources of View, App, Site, Global etc. Will retrieve values by priority, with View-Resources being top priority and Preset-Resources being the lowest. Tip If you know that Resources come from the App, you should prefer App.Resources instead. That is faster and helps people reading your code figure out where to change a value. public ITypedStack AllResources { get; } Property Value ITypedStack AllSettings Stack of all Settings in the System, merging Settings of View, App, Site, Global etc. Will retrieve values by priority, with View-Settings being top priority and Preset-Settings being the lowest. Tip If you know that Settings come from the App, you should prefer App.Settings instead. That is faster and helps people reading your code figure out where to change a value. public ITypedStack AllSettings { get; } Property Value ITypedStack App The current App object (with strictly typed Settings/Resources). Use it to access App properties such as Path or any data in the App. public IAppTyped App { get; } Property Value IAppTyped Kit The Service Kit containing all kinds of services which are commonly used. The services on the Kit are context-aware, so they know what App is currently being used etc. public ServiceKit16 Kit { get; } Property Value ServiceKit16 Link Link helper object to create the correct links public ILinkService Link { get; } Property Value ILinkService A ILinkService object. Log The logger for the current Razor / WebApi which allows you to add logs to Insights. public ICodeLog Log { get; } Property Value ICodeLog MyContext This Context tells you about the environment, such as the current User the Page the View the Site It's supposed to replace direct access to Dnn or Oqtane object in Razor and WebAPI code, allowing hybrid code that works everywhere. public ICmsContext MyContext { get; } Property Value ICmsContext Remarks New in v11.11 MyData All the data which the current Template received, based on the View configuration. There are a few common scenarios: If it's a simple view, then this will just contain streams with the main Item(s) and Header If the view expects no data, it will just contain a Default stream containing no items If the view has a Query behind it, then MyData will have all the streams provided by the Query public IBlockInstance MyData { get; } Property Value IBlockInstance MyHeader The Header-Item belonging to this Template/Module. This data is edited by the user directly on this specific module. In some cases it can also be a pre-set item configured in the View to be used if the user has not added any data himself. public ITypedItem MyHeader { get; } Property Value ITypedItem MyItem The main Item belonging to this Template/Module. This data is edited by the user directly on this specific module. In some cases it can also be a pre-set item configured in the View to be used if the user has not added any data himself. If this view can have a list of items (more than one) then this contains the first item. To get all the items, see MyItems public ITypedItem MyItem { get; } Property Value ITypedItem MyItems List of all Items belonging to this Template/Module. This data is edited by the user directly on this specific module. In some cases it can also be a pre-set item configured in the View to be used if the user has not added any data himself. If this view is configured to only have one item, then this list will only contain one item. Otherwise it will have as many items as the editor added. public IEnumerable MyItems { get; } Property Value IEnumerable MyModel Data passed to this Razor template by a caller. This is typical for Razor components which are re-used, and called from other Razor templates using @Html.Partial(\"filename.cshtml\", new { thing = 7 }). public ITypedModel MyModel { get; } Property Value ITypedModel MyPage Information about the current Page (called Tab in DNN). It's especially useful to get current URL Parameters. public ICmsPage MyPage { get; } Property Value ICmsPage MyUser Information about the current user. It's especially useful to see if the user has any kind of Admin privileges. public ICmsUser MyUser { get; } Property Value ICmsUser MyView View-information such as the view Name, Identity or Edition. public ICmsView MyView { get; } Property Value ICmsView Remarks New in v12.02 UniqueKey A unique, random key for the current module. It's recommended for giving DOM elements a unique id for scripts to then access them. It's generated for every content-block, and more reliable than Module.Id since that sometimes results in duplicate keys, if the many blocks are used inside each other. It's generated using a GUID and converted/shortened. In the current version it's 8 characters long, so it has 10^14 combinations, making collisions extremely unlikely. (currently 8 characters) Tip To get a unique key which is based on additional objects such as Entities, use the UniqueKeyWith(params object[]) method. public string UniqueKey { get; } Property Value string Remarks If you get a fresh IKeyService it will also create a new UniqueKey. So your code should usually use the built-in property UniqueKey which comes from the shared ServiceKit Key. Methods Accepted() Creates a .net-core like AcceptedResult object that produces an .net-core like StatusCodes.Status202Accepted response. Typical use: return Accepted(); [NonAction] public HttpResponseMessage Accepted() Returns HttpResponseMessage The created .net-core like AcceptedResult for the response. Remarks This is a shim to ensure that .net Framework code can be written the same way as .net core WebApis. It returns a dynamic to make it easy to use, but the real .net core implementation returns a typed object. AsEntity(ICanBeEntity) Unwraps a dynamic entity or ITypedItem back into the underlying IEntity public IEntity AsEntity(ICanBeEntity thing) Parameters thing ICanBeEntity Returns IEntity A normal IEntity AsItem(object, NoParamOrder, bool?, bool?) Convert something to a ITypedItem. This works for all kinds of IEntitys, IDynamicEntitys as well as Lists/IEnumerables of those. Will always return a single item. If a list is provided, it will return the first item in the list. If null was provided, it will return null. public ITypedItem AsItem(object data, NoParamOrder noParamOrder = default, bool? propsRequired = null, bool? mock = null) Parameters data object An original object which can be converted to a TypedItem, such as a IEntity . noParamOrder NoParamOrder see Convention: Named Parameters propsRequired bool? make the resulting object strict, default true mock bool? Specify that the data is fake/mock data, which should pretend to be an Item. Default is false Returns ITypedItem Remarks New in v16.02 AsItems(object, NoParamOrder, bool?) Convert an object containing a list of Entities or similar to a list of ITypedItems. public IEnumerable AsItems(object list, NoParamOrder noParamOrder = default, bool? propsRequired = null) Parameters list object The original list which is usually a list of IEntity objects. noParamOrder NoParamOrder see Convention: Named Parameters propsRequired bool? make the resulting object strict, default true Returns IEnumerable Remarks New in v16.01 AsList(object, NoParamOrder, bool) Convert a list of Entities or TypedItems into a strongly typed list. Typically, the type will be from your AppCode.Data. public IEnumerable AsList(object source, NoParamOrder protector = default, bool nullIfNull = false) where T : class, ITypedItemWrapper16, ITypedItem, new() Parameters source object the source object - a List/Enumerable of IEntity or ITypedItem protector NoParamOrder see Convention: Named Parameters nullIfNull bool if true will return null when source is null - otherwise a wrapper item with empty-contents Returns IEnumerable Type Parameters T the target type Remarks Release in v17.05 AsStack(params object[]) Create a typed object which will provide all the properties of the things wrapped inside it. The priority is first-object first, so if multiple items have the property, the first in the list will be returned. public ITypedStack AsStack(params object[] items) Parameters items object[] Returns ITypedStack AsTyped(object, NoParamOrder, bool?) Creates a typed object to read the original passed into this function. This is usually used to process objects which the compiler can't know, such as anonymous objects returned from helper code etc. If you have an array of such objects, use AsTypedList(object, NoParamOrder, bool?). public ITyped AsTyped(object original, NoParamOrder noParamOrder = default, bool? propsRequired = null) Parameters original object noParamOrder NoParamOrder see Convention: Named Parameters propsRequired bool? make the resulting object strict, default true Returns ITyped AsTypedList(object, NoParamOrder, bool?) Create a list public IEnumerable AsTypedList(object list, NoParamOrder noParamOrder = default, bool? propsRequired = null) Parameters list object List/Enumerable object containing a bunch of items to make typed noParamOrder NoParamOrder see Convention: Named Parameters propsRequired bool? make the resulting object strict, default true Returns IEnumerable As(object, NoParamOrder, bool) Convert an Entity or TypedItem into a strongly typed object. Typically, the type will be from your AppCode.Data. public T As(object source, NoParamOrder protector = default, bool mock = false) where T : class, ITypedItemWrapper16, ITypedItem, new() Parameters source object the source object - an IEntity or ITypedItem protector NoParamOrder see Convention: Named Parameters mock bool if true will return a fake when source is null - otherwise a wrapper item with empty-contents Returns T Type Parameters T the target type Remarks Released v17.05 BadRequest() Creates an .net-core like BadRequestResult that produces a .net-core like StatusCodes.Status400BadRequest response. Typical use: return BadRequest(); [NonAction] public BadRequestResult BadRequest() Returns BadRequestResult The created .net-core like BadRequestResult for the response. Remarks This is a shim to ensure that .net Framework code can be written the same way as .net core WebApis. It returns a dynamic to make it easy to use, but the real .net core implementation returns a typed object. Conflict() Creates an .net-core like ConflictResult that produces a .net-core like StatusCodes.Status409Conflict response. Typical use: return Conflict(); [NonAction] public ConflictResult Conflict() Returns ConflictResult The created .net-core like ConflictResult for the response. Remarks This is a shim to ensure that .net Framework code can be written the same way as .net core WebApis. It returns a dynamic to make it easy to use, but the real .net core implementation returns a typed object. Conflict(object) Creates an .net-core like ConflictObjectResult that produces a .net-core like StatusCodes.Status409Conflict response. Typical use: return Conflict(\"the stored file is newer\"); [NonAction] public HttpResponseMessage Conflict(object error) Parameters error object Contains errors to be returned to the client. Returns HttpResponseMessage The created .net-core like ConflictObjectResult for the response. Remarks This is a shim to ensure that .net Framework code can be written the same way as .net core WebApis. It returns a dynamic to make it easy to use, but the real .net core implementation returns a typed object. File(NoParamOrder, bool?, string, string, string, object) Create a File-result to stream to the client Typical use: return File(download: true, contentType: \"text/xml\", contents: ...); public dynamic File(NoParamOrder noParamOrder = default, bool? download = null, string virtualPath = null, string contentType = null, string fileDownloadName = null, object contents = null) Parameters noParamOrder NoParamOrder see Convention: Named Parameters download bool? If a download should be enforced (otherwise the file may just be displayed - like an image) virtualPath string Path in the website to get the file from. Provide either virtualPath or contents contentType string Mime Content-type. Will try to auto-detect from virtualPath or fileDownloadName if not provided. fileDownloadName string Download name. If provided, it will try to force download/save on the browser. contents object Content of the result - a string, byte[] or stream to include. Returns dynamic Remarks Added in 2sxc 12.05 Forbid() Creates a .net-core like ForbidResult (.net-core like StatusCodes.Status403Forbidden by default). Typical use: return Forbid(); [NonAction] public HttpResponseMessage Forbid() Returns HttpResponseMessage The created .net-core like ForbidResult for the response. Remarks This is a shim to ensure that .net Framework code can be written the same way as .net core WebApis. It returns a dynamic to make it easy to use, but the real .net core implementation returns a typed object. Some authentication schemes, such as cookies, will convert .net-core like StatusCodes.Status403Forbidden to a redirect to show a login page. GetCode(string, NoParamOrder, string) Create an instance of a class in a .cs code file. Note that the class name in the file must match the file name, so MyHelpers.cs must have a MyHelpers class. public dynamic GetCode(string path, NoParamOrder noParamOrder = default, string className = null) Parameters path string The path, like Helper.cs, ./helper.cs, ../../Helper.cs or /SomeFolderInApp/Helper.cs (new 16.05) noParamOrder NoParamOrder see Convention: Named Parameters className string Optional class name, if it doesn't match the file name (new 16.03) Returns dynamic , Remarks Created in 16.02 className added in 16.03 Ability to give a path beginning with / as app-root in 16.05 In older code there was a similar CreateInstance method GetService() Get a service from the Dependency Injection. The service can come from 2sxc, EAV or the underlying platform (Dnn, Oqtane). public TService GetService() where TService : class Returns TService An object of the type or interface requested, or null if not found in the DI. Type Parameters TService Interface (preferred) or Class which is needed NoContent() Creates a .net-core like NoContentResult object that produces an empty .net-core like StatusCodes.Status204NoContent response. Typical use: return NoContent(); [NonAction] public HttpResponseMessage NoContent() Returns HttpResponseMessage The created .net-core like NoContentResult object for the response. Remarks This is a shim to ensure that .net Framework code can be written the same way as .net core WebApis. It returns a dynamic to make it easy to use, but the real .net core implementation returns a typed object. NotFound() Creates an .net-core like NotFoundResult that produces a .net-core like StatusCodes.Status404NotFound response. Typical use: return NotFound(); [NonAction] public NotFoundResult NotFound() Returns NotFoundResult The created .net-core like NotFoundResult for the response. Remarks This is a shim to ensure that .net Framework code can be written the same way as .net core WebApis. It returns a dynamic to make it easy to use, but the real .net core implementation returns a typed object. NotFound(object) Creates an .net-core like NotFoundObjectResult that produces a .net-core like StatusCodes.Status404NotFound response. Typical use: return Unauthorized(\"try another ID\"); [NonAction] public HttpResponseMessage NotFound(object value) Parameters value object Returns HttpResponseMessage The created .net-core like NotFoundObjectResult for the response. Remarks This is a shim to ensure that .net Framework code can be written the same way as .net core WebApis. It returns a dynamic to make it easy to use, but the real .net core implementation returns a typed object. Ok() Creates a .net-core like OkResult object that produces an empty .net-core like StatusCodes.Status200OK response. Typical use: return Ok(); [NonAction] public OkResult Ok() Returns OkResult The created .net-core like OkResult for the response. Remarks This is a shim to ensure that .net Framework code can be written the same way as .net core WebApis. It returns a dynamic to make it easy to use, but the real .net core implementation returns a typed object. Ok(object) Creates an .net-core like OkObjectResult object that produces an .net-core like StatusCodes.Status200OK response. Typical use: return Ok(objectToInclude); [NonAction] public HttpResponseMessage Ok(object value) Parameters value object The content value to format in the entity body. Returns HttpResponseMessage The created .net-core like OkObjectResult for the response. Remarks This is a shim to ensure that .net Framework code can be written the same way as .net core WebApis. It returns a dynamic to make it easy to use, but the real .net core implementation returns a typed object. Redirect(string) Creates a .net-core like RedirectResult object that redirects (.net-core like StatusCodes.Status302Found) to the specified url. Typical use: return Redirect(\"https://2sxc.org\"); [NonAction] public RedirectResult Redirect(string url) Parameters url string The URL to redirect to. Returns RedirectResult The created .net-core like RedirectResult for the response. Remarks This is a shim to ensure that .net Framework code can be written the same way as .net core WebApis. It returns a dynamic to make it easy to use, but the real .net core implementation returns a typed object. RedirectPermanent(string) Creates a .net-core like RedirectResult object with .net-core like RedirectResult.Permanent set to true (.net-core like StatusCodes.Status301MovedPermanently) using the specified url. Typical use: return RedirectPermanent(\"https://2sxc.org\"); [NonAction] public HttpResponseMessage RedirectPermanent(string url) Parameters url string The URL to redirect to. Returns HttpResponseMessage The created .net-core like RedirectResult for the response. Remarks This is a shim to ensure that .net Framework code can be written the same way as .net core WebApis. It returns a dynamic to make it easy to use, but the real .net core implementation returns a typed object. SaveInAdam(NoParamOrder, Stream, string, string, Guid?, string, string) Save a file from a stream (usually an upload from the browser) into an adam-field of an item. Read more about this in the WebAPI docs for SaveInAdam public IFile SaveInAdam(NoParamOrder noParamOrder = default, Stream stream = null, string fileName = null, string contentType = null, Guid? guid = null, string field = null, string subFolder = \"\") Parameters noParamOrder NoParamOrder see Convention: Named Parameters stream Stream the stream fileName string file name to save to contentType string content-type of the target item (important for security checks) guid Guid? field string subFolder string Returns IFile StatusCode(int) Creates a .net-core like StatusCodeResult object by specifying a statusCode. Typical use: return StatusCode(403); [NonAction] public HttpResponseMessage StatusCode(int statusCode) Parameters statusCode int The status code to set on the response. Returns HttpResponseMessage The created .net-core like StatusCodeResult object for the response. Remarks This is a shim to ensure that .net Framework code can be written the same way as .net core WebApis. It returns a dynamic to make it easy to use, but the real .net core implementation returns a typed object. StatusCode(int, object) Creates a .net-core like ObjectResult object by specifying a statusCode and value Typical use: return StatusCode(304, \"not modified\"); [NonAction] public HttpResponseMessage StatusCode(int statusCode, object value) Parameters statusCode int The status code to set on the response. value object The value to set on the .net-core like `ObjectResult\"/>. Returns HttpResponseMessage The created .net-core like ObjectResult object for the response. Remarks This is a shim to ensure that .net Framework code can be written the same way as .net core WebApis. It returns a dynamic to make it easy to use, but the real .net core implementation returns a typed object. Unauthorized() Creates an .net-core like UnauthorizedResult that produces an .net-core like StatusCodes.Status401Unauthorized response. Typical use: return Unauthorized(); [NonAction] public HttpResponseMessage Unauthorized() Returns HttpResponseMessage The created .net-core like UnauthorizedResult for the response. Remarks This is a shim to ensure that .net Framework code can be written the same way as .net core WebApis. It returns a dynamic to make it easy to use, but the real .net core implementation returns a typed object. Unauthorized(object) Creates an .net-core like UnauthorizedObjectResult that produces a .net-core like StatusCodes.Status401Unauthorized response. Typical use: return Unauthorized(\"we don't like this\"); [NonAction] public HttpResponseMessage Unauthorized(object value) Parameters value object Returns HttpResponseMessage The created .net-core like UnauthorizedObjectResult for the response. Remarks This is a shim to ensure that .net Framework code can be written the same way as .net core WebApis. It returns a dynamic to make it easy to use, but the real .net core implementation returns a typed object." + "keywords": "Class ApiTyped Namespace Custom.Hybrid Assembly ToSic.Sxc.Dnn.WebApi.dll Base class for v16 Typed WebAPI files. Use it to create custom WebAPI endpoints in your App. It provides the ServiceKit16 on property Kit which contains all the popular services to create amazing stuff. [PublicApi] [JsonFormatter] public abstract class ApiTyped : DnnSxcCustomControllerBase, IHasLog Inheritance object ApiController DnnApiController DnnSxcControllerRoot DnnSxcControllerBase DnnSxcCustomControllerBase ApiTyped Implements IHasLog Remarks Important: This is very different from Razor12 or Razor14, as it doesn't rely on dynamic code. Be aware of this since the APIs are very different - see Typed Code. Constructors ApiTyped() Main constructor. Doesn't have parameters so it can easily be inherited. protected ApiTyped() ApiTyped(string) Alternate constructor to use when inheriting, placing the Insights logs in an own section. protected ApiTyped(string insightsGroup) Parameters insightsGroup string Name of the section in Insights Properties AllResources Stack of all Resources in the System, merging Resources of View, App, Site, Global etc. Will retrieve values by priority, with View-Resources being top priority and Preset-Resources being the lowest. Tip If you know that Resources come from the App, you should prefer App.Resources instead. That is faster and helps people reading your code figure out where to change a value. public ITypedStack AllResources { get; } Property Value ITypedStack AllSettings Stack of all Settings in the System, merging Settings of View, App, Site, Global etc. Will retrieve values by priority, with View-Settings being top priority and Preset-Settings being the lowest. Tip If you know that Settings come from the App, you should prefer App.Settings instead. That is faster and helps people reading your code figure out where to change a value. public ITypedStack AllSettings { get; } Property Value ITypedStack App The current App object (with strictly typed Settings/Resources). Use it to access App properties such as Path or any data in the App. public IAppTyped App { get; } Property Value IAppTyped Kit The Service Kit containing all kinds of services which are commonly used. The services on the Kit are context-aware, so they know what App is currently being used etc. public ServiceKit16 Kit { get; } Property Value ServiceKit16 Link Link helper object to create the correct links public ILinkService Link { get; } Property Value ILinkService A ILinkService object. Log The logger for the current Razor / WebApi which allows you to add logs to Insights. public ICodeLog Log { get; } Property Value ICodeLog MyContext This Context tells you about the environment, such as the current User the Page the View the Site It's supposed to replace direct access to Dnn or Oqtane object in Razor and WebAPI code, allowing hybrid code that works everywhere. public ICmsContext MyContext { get; } Property Value ICmsContext Remarks New in v11.11 MyData All the data which the current Template received, based on the View configuration. There are a few common scenarios: If it's a simple view, then this will just contain streams with the main Item(s) and Header If the view expects no data, it will just contain a Default stream containing no items If the view has a Query behind it, then MyData will have all the streams provided by the Query public IBlockInstance MyData { get; } Property Value IBlockInstance MyHeader The Header-Item belonging to this Template/Module. This data is edited by the user directly on this specific module. In some cases it can also be a pre-set item configured in the View to be used if the user has not added any data himself. public ITypedItem MyHeader { get; } Property Value ITypedItem MyItem The main Item belonging to this Template/Module. This data is edited by the user directly on this specific module. In some cases it can also be a pre-set item configured in the View to be used if the user has not added any data himself. If this view can have a list of items (more than one) then this contains the first item. To get all the items, see MyItems public ITypedItem MyItem { get; } Property Value ITypedItem MyItems List of all Items belonging to this Template/Module. This data is edited by the user directly on this specific module. In some cases it can also be a pre-set item configured in the View to be used if the user has not added any data himself. If this view is configured to only have one item, then this list will only contain one item. Otherwise it will have as many items as the editor added. public IEnumerable MyItems { get; } Property Value IEnumerable MyModel Data passed to this Razor template by a caller. This is typical for Razor components which are re-used, and called from other Razor templates using @Html.Partial(\"filename.cshtml\", new { thing = 7 }). public ITypedModel MyModel { get; } Property Value ITypedModel MyPage Information about the current Page (called Tab in DNN). It's especially useful to get current URL Parameters. public ICmsPage MyPage { get; } Property Value ICmsPage MyUser Information about the current user. It's especially useful to see if the user has any kind of Admin privileges. public ICmsUser MyUser { get; } Property Value ICmsUser MyView View-information such as the view Name, Identity or Edition. public ICmsView MyView { get; } Property Value ICmsView Remarks New in v12.02 UniqueKey A unique, random key for the current module. It's recommended for giving DOM elements a unique id for scripts to then access them. It's generated for every content-block, and more reliable than Module.Id since that sometimes results in duplicate keys, if the many blocks are used inside each other. It's generated using a GUID and converted/shortened. In the current version it's 8 characters long, so it has 10^14 combinations, making collisions extremely unlikely. (currently 8 characters) Tip To get a unique key which is based on additional objects such as Entities, use the UniqueKeyWith(params object[]) method. public string UniqueKey { get; } Property Value string Remarks If you get a fresh IKeyService it will also create a new UniqueKey. So your code should usually use the built-in property UniqueKey which comes from the shared ServiceKit Key. Methods Accepted() Creates a .net-core like AcceptedResult object that produces an .net-core like StatusCodes.Status202Accepted response. Typical use: return Accepted(); [NonAction] public HttpResponseMessage Accepted() Returns HttpResponseMessage The created .net-core like AcceptedResult for the response. Remarks This is a shim to ensure that .net Framework code can be written the same way as .net core WebApis. It returns a dynamic to make it easy to use, but the real .net core implementation returns a typed object. AsEntity(ICanBeEntity) Unwraps a dynamic entity or ITypedItem back into the underlying IEntity public IEntity AsEntity(ICanBeEntity thing) Parameters thing ICanBeEntity Returns IEntity A normal IEntity AsItem(object, NoParamOrder, bool?, bool?) Convert something to a ITypedItem. This works for all kinds of IEntitys, IDynamicEntitys as well as Lists/IEnumerables of those. Will always return a single item. If a list is provided, it will return the first item in the list. If null was provided, it will return null. public ITypedItem AsItem(object data, NoParamOrder noParamOrder = default, bool? propsRequired = null, bool? mock = null) Parameters data object An original object which can be converted to a TypedItem, such as a IEntity . noParamOrder NoParamOrder see Convention: Named Parameters propsRequired bool? make the resulting object strict, default true mock bool? Specify that the data is fake/mock data, which should pretend to be an Item. Default is false Returns ITypedItem Remarks New in v16.02 AsItems(object, NoParamOrder, bool?) Convert an object containing a list of Entities or similar to a list of ITypedItems. public IEnumerable AsItems(object list, NoParamOrder noParamOrder = default, bool? propsRequired = null) Parameters list object The original list which is usually a list of IEntity objects. noParamOrder NoParamOrder see Convention: Named Parameters propsRequired bool? make the resulting object strict, default true Returns IEnumerable Remarks New in v16.01 AsList(object, NoParamOrder, bool) Convert a list of Entities or TypedItems into a strongly typed list. Typically, the type will be from your AppCode.Data. public IEnumerable AsList(object source, NoParamOrder protector = default, bool nullIfNull = false) where T : class, ITypedItemWrapper16, ITypedItem, new() Parameters source object the source object - a List/Enumerable of IEntity or ITypedItem protector NoParamOrder see Convention: Named Parameters nullIfNull bool if true will return null when source is null - otherwise a wrapper item with empty-contents Returns IEnumerable Type Parameters T the target type Remarks Release in v17.05 AsStack(params object[]) Create a typed object which will provide all the properties of the things wrapped inside it. The priority is first-object first, so if multiple items have the property, the first in the list will be returned. public ITypedStack AsStack(params object[] items) Parameters items object[] objects to stack together Returns ITypedStack AsStack(params object[]) Create a custom-typed object which will provide all the properties of the things wrapped inside it. The priority is first-object first, so if multiple items have the property, the first in the list will be returned. public T AsStack(params object[] items) where T : class, ITypedItemWrapper16, ITypedItem, new() Parameters items object[] objects to stack together Returns T Item of the custom type Type Parameters T Remarks New in 17.07 AsTyped(object, NoParamOrder, bool?) Creates a typed object to read the original passed into this function. This is usually used to process objects which the compiler can't know, such as anonymous objects returned from helper code etc. If you have an array of such objects, use AsTypedList(object, NoParamOrder, bool?). public ITyped AsTyped(object original, NoParamOrder noParamOrder = default, bool? propsRequired = null) Parameters original object noParamOrder NoParamOrder see Convention: Named Parameters propsRequired bool? make the resulting object strict, default true Returns ITyped AsTypedList(object, NoParamOrder, bool?) Create a list public IEnumerable AsTypedList(object list, NoParamOrder noParamOrder = default, bool? propsRequired = null) Parameters list object List/Enumerable object containing a bunch of items to make typed noParamOrder NoParamOrder see Convention: Named Parameters propsRequired bool? make the resulting object strict, default true Returns IEnumerable As(object, NoParamOrder, bool) Convert an Entity or TypedItem into a strongly typed object. Typically, the type will be from your AppCode.Data. public T As(object source, NoParamOrder protector = default, bool mock = false) where T : class, ITypedItemWrapper16, ITypedItem, new() Parameters source object the source object - an IEntity or ITypedItem protector NoParamOrder see Convention: Named Parameters mock bool if true will return a fake when source is null - otherwise a wrapper item with empty-contents Returns T Type Parameters T the target type Remarks Released v17.05 BadRequest() Creates an .net-core like BadRequestResult that produces a .net-core like StatusCodes.Status400BadRequest response. Typical use: return BadRequest(); [NonAction] public BadRequestResult BadRequest() Returns BadRequestResult The created .net-core like BadRequestResult for the response. Remarks This is a shim to ensure that .net Framework code can be written the same way as .net core WebApis. It returns a dynamic to make it easy to use, but the real .net core implementation returns a typed object. Conflict() Creates an .net-core like ConflictResult that produces a .net-core like StatusCodes.Status409Conflict response. Typical use: return Conflict(); [NonAction] public ConflictResult Conflict() Returns ConflictResult The created .net-core like ConflictResult for the response. Remarks This is a shim to ensure that .net Framework code can be written the same way as .net core WebApis. It returns a dynamic to make it easy to use, but the real .net core implementation returns a typed object. Conflict(object) Creates an .net-core like ConflictObjectResult that produces a .net-core like StatusCodes.Status409Conflict response. Typical use: return Conflict(\"the stored file is newer\"); [NonAction] public HttpResponseMessage Conflict(object error) Parameters error object Contains errors to be returned to the client. Returns HttpResponseMessage The created .net-core like ConflictObjectResult for the response. Remarks This is a shim to ensure that .net Framework code can be written the same way as .net core WebApis. It returns a dynamic to make it easy to use, but the real .net core implementation returns a typed object. File(NoParamOrder, bool?, string, string, string, object) Create a File-result to stream to the client Typical use: return File(download: true, contentType: \"text/xml\", contents: ...); public dynamic File(NoParamOrder noParamOrder = default, bool? download = null, string virtualPath = null, string contentType = null, string fileDownloadName = null, object contents = null) Parameters noParamOrder NoParamOrder see Convention: Named Parameters download bool? If a download should be enforced (otherwise the file may just be displayed - like an image) virtualPath string Path in the website to get the file from. Provide either virtualPath or contents contentType string Mime Content-type. Will try to auto-detect from virtualPath or fileDownloadName if not provided. fileDownloadName string Download name. If provided, it will try to force download/save on the browser. contents object Content of the result - a string, byte[] or stream to include. Returns dynamic Remarks Added in 2sxc 12.05 Forbid() Creates a .net-core like ForbidResult (.net-core like StatusCodes.Status403Forbidden by default). Typical use: return Forbid(); [NonAction] public HttpResponseMessage Forbid() Returns HttpResponseMessage The created .net-core like ForbidResult for the response. Remarks This is a shim to ensure that .net Framework code can be written the same way as .net core WebApis. It returns a dynamic to make it easy to use, but the real .net core implementation returns a typed object. Some authentication schemes, such as cookies, will convert .net-core like StatusCodes.Status403Forbidden to a redirect to show a login page. GetCode(string, NoParamOrder, string) Create an instance of a class in a .cs code file. Note that the class name in the file must match the file name, so MyHelpers.cs must have a MyHelpers class. public dynamic GetCode(string path, NoParamOrder noParamOrder = default, string className = null) Parameters path string The path, like Helper.cs, ./helper.cs, ../../Helper.cs or /SomeFolderInApp/Helper.cs (new 16.05) noParamOrder NoParamOrder see Convention: Named Parameters className string Optional class name, if it doesn't match the file name (new 16.03) Returns dynamic , Remarks Created in 16.02 className added in 16.03 Ability to give a path beginning with / as app-root in 16.05 In older code there was a similar CreateInstance method GetService() Get a service from the Dependency Injection. The service can come from 2sxc, EAV or the underlying platform (Dnn, Oqtane). public TService GetService() where TService : class Returns TService An object of the type or interface requested, or null if not found in the DI. Type Parameters TService Interface (preferred) or Class which is needed NoContent() Creates a .net-core like NoContentResult object that produces an empty .net-core like StatusCodes.Status204NoContent response. Typical use: return NoContent(); [NonAction] public HttpResponseMessage NoContent() Returns HttpResponseMessage The created .net-core like NoContentResult object for the response. Remarks This is a shim to ensure that .net Framework code can be written the same way as .net core WebApis. It returns a dynamic to make it easy to use, but the real .net core implementation returns a typed object. NotFound() Creates an .net-core like NotFoundResult that produces a .net-core like StatusCodes.Status404NotFound response. Typical use: return NotFound(); [NonAction] public NotFoundResult NotFound() Returns NotFoundResult The created .net-core like NotFoundResult for the response. Remarks This is a shim to ensure that .net Framework code can be written the same way as .net core WebApis. It returns a dynamic to make it easy to use, but the real .net core implementation returns a typed object. NotFound(object) Creates an .net-core like NotFoundObjectResult that produces a .net-core like StatusCodes.Status404NotFound response. Typical use: return Unauthorized(\"try another ID\"); [NonAction] public HttpResponseMessage NotFound(object value) Parameters value object Returns HttpResponseMessage The created .net-core like NotFoundObjectResult for the response. Remarks This is a shim to ensure that .net Framework code can be written the same way as .net core WebApis. It returns a dynamic to make it easy to use, but the real .net core implementation returns a typed object. Ok() Creates a .net-core like OkResult object that produces an empty .net-core like StatusCodes.Status200OK response. Typical use: return Ok(); [NonAction] public OkResult Ok() Returns OkResult The created .net-core like OkResult for the response. Remarks This is a shim to ensure that .net Framework code can be written the same way as .net core WebApis. It returns a dynamic to make it easy to use, but the real .net core implementation returns a typed object. Ok(object) Creates an .net-core like OkObjectResult object that produces an .net-core like StatusCodes.Status200OK response. Typical use: return Ok(objectToInclude); [NonAction] public HttpResponseMessage Ok(object value) Parameters value object The content value to format in the entity body. Returns HttpResponseMessage The created .net-core like OkObjectResult for the response. Remarks This is a shim to ensure that .net Framework code can be written the same way as .net core WebApis. It returns a dynamic to make it easy to use, but the real .net core implementation returns a typed object. Redirect(string) Creates a .net-core like RedirectResult object that redirects (.net-core like StatusCodes.Status302Found) to the specified url. Typical use: return Redirect(\"https://2sxc.org\"); [NonAction] public RedirectResult Redirect(string url) Parameters url string The URL to redirect to. Returns RedirectResult The created .net-core like RedirectResult for the response. Remarks This is a shim to ensure that .net Framework code can be written the same way as .net core WebApis. It returns a dynamic to make it easy to use, but the real .net core implementation returns a typed object. RedirectPermanent(string) Creates a .net-core like RedirectResult object with .net-core like RedirectResult.Permanent set to true (.net-core like StatusCodes.Status301MovedPermanently) using the specified url. Typical use: return RedirectPermanent(\"https://2sxc.org\"); [NonAction] public HttpResponseMessage RedirectPermanent(string url) Parameters url string The URL to redirect to. Returns HttpResponseMessage The created .net-core like RedirectResult for the response. Remarks This is a shim to ensure that .net Framework code can be written the same way as .net core WebApis. It returns a dynamic to make it easy to use, but the real .net core implementation returns a typed object. SaveInAdam(NoParamOrder, Stream, string, string, Guid?, string, string) Save a file from a stream (usually an upload from the browser) into an adam-field of an item. Read more about this in the WebAPI docs for SaveInAdam public IFile SaveInAdam(NoParamOrder noParamOrder = default, Stream stream = null, string fileName = null, string contentType = null, Guid? guid = null, string field = null, string subFolder = \"\") Parameters noParamOrder NoParamOrder see Convention: Named Parameters stream Stream the stream fileName string file name to save to contentType string content-type of the target item (important for security checks) guid Guid? field string subFolder string Returns IFile StatusCode(int) Creates a .net-core like StatusCodeResult object by specifying a statusCode. Typical use: return StatusCode(403); [NonAction] public HttpResponseMessage StatusCode(int statusCode) Parameters statusCode int The status code to set on the response. Returns HttpResponseMessage The created .net-core like StatusCodeResult object for the response. Remarks This is a shim to ensure that .net Framework code can be written the same way as .net core WebApis. It returns a dynamic to make it easy to use, but the real .net core implementation returns a typed object. StatusCode(int, object) Creates a .net-core like ObjectResult object by specifying a statusCode and value Typical use: return StatusCode(304, \"not modified\"); [NonAction] public HttpResponseMessage StatusCode(int statusCode, object value) Parameters statusCode int The status code to set on the response. value object The value to set on the .net-core like `ObjectResult\"/>. Returns HttpResponseMessage The created .net-core like ObjectResult object for the response. Remarks This is a shim to ensure that .net Framework code can be written the same way as .net core WebApis. It returns a dynamic to make it easy to use, but the real .net core implementation returns a typed object. Unauthorized() Creates an .net-core like UnauthorizedResult that produces an .net-core like StatusCodes.Status401Unauthorized response. Typical use: return Unauthorized(); [NonAction] public HttpResponseMessage Unauthorized() Returns HttpResponseMessage The created .net-core like UnauthorizedResult for the response. Remarks This is a shim to ensure that .net Framework code can be written the same way as .net core WebApis. It returns a dynamic to make it easy to use, but the real .net core implementation returns a typed object. Unauthorized(object) Creates an .net-core like UnauthorizedObjectResult that produces a .net-core like StatusCodes.Status401Unauthorized response. Typical use: return Unauthorized(\"we don't like this\"); [NonAction] public HttpResponseMessage Unauthorized(object value) Parameters value object Returns HttpResponseMessage The created .net-core like UnauthorizedObjectResult for the response. Remarks This is a shim to ensure that .net Framework code can be written the same way as .net core WebApis. It returns a dynamic to make it easy to use, but the real .net core implementation returns a typed object." }, "api/dot-net/Custom.Hybrid.Code12.html": { "href": "api/dot-net/Custom.Hybrid.Code12.html", @@ -897,7 +897,7 @@ "api/dot-net/Custom.Hybrid.CodeTyped.html": { "href": "api/dot-net/Custom.Hybrid.CodeTyped.html", "title": "Class CodeTyped | 2sxc 17 for Dnn and Oqtane", - "keywords": "Class CodeTyped Namespace Custom.Hybrid Assembly ToSic.Sxc.dll Base class for v16 Typed CSharp files. Use it to create custom CS code in your App. It provides the ServiceKit16 on property Kit which contains all the popular services to create amazing stuff. [PublicApi] public abstract class CodeTyped : CustomCodeBase, ICanDebug, IHasLog Inheritance object ServiceBase ServiceForDynamicCode CustomCodeBase CodeTyped Implements ICanDebug IHasLog Remarks Important: This is very different from Razor12 or Razor14, as it doesn't rely on dynamic code. Be aware of this since the APIs are very different - see Typed Code. Constructors CodeTyped() Main constructor. Doesn't have parameters so it can easily be inherited. protected CodeTyped() Properties AllResources Stack of all Resources in the System, merging Resources of View, App, Site, Global etc. Will retrieve values by priority, with View-Resources being top priority and Preset-Resources being the lowest. Tip If you know that Resources come from the App, you should prefer App.Resources instead. That is faster and helps people reading your code figure out where to change a value. public ITypedStack AllResources { get; } Property Value ITypedStack AllSettings Stack of all Settings in the System, merging Settings of View, App, Site, Global etc. Will retrieve values by priority, with View-Settings being top priority and Preset-Settings being the lowest. Tip If you know that Settings come from the App, you should prefer App.Settings instead. That is faster and helps people reading your code figure out where to change a value. public ITypedStack AllSettings { get; } Property Value ITypedStack App The current App object (with strictly typed Settings/Resources). Use it to access App properties such as Path or any data in the App. public IAppTyped App { get; } Property Value IAppTyped Kit public ServiceKit16 Kit { get; } Property Value ServiceKit16 Link Link helper object to create the correct links public ILinkService Link { get; } Property Value ILinkService A ILinkService object. Log The logger for the current Razor / WebApi which allows you to add logs to Insights. public ICodeLog Log { get; } Property Value ICodeLog MyContext This Context tells you about the environment, such as the current User the Page the View the Site It's supposed to replace direct access to Dnn or Oqtane object in Razor and WebAPI code, allowing hybrid code that works everywhere. public ICmsContext MyContext { get; } Property Value ICmsContext Remarks New in v11.11 MyData All the data which the current Template received, based on the View configuration. There are a few common scenarios: If it's a simple view, then this will just contain streams with the main Item(s) and Header If the view expects no data, it will just contain a Default stream containing no items If the view has a Query behind it, then MyData will have all the streams provided by the Query public IBlockInstance MyData { get; } Property Value IBlockInstance MyHeader The Header-Item belonging to this Template/Module. This data is edited by the user directly on this specific module. In some cases it can also be a pre-set item configured in the View to be used if the user has not added any data himself. public ITypedItem MyHeader { get; } Property Value ITypedItem MyItem The main Item belonging to this Template/Module. This data is edited by the user directly on this specific module. In some cases it can also be a pre-set item configured in the View to be used if the user has not added any data himself. If this view can have a list of items (more than one) then this contains the first item. To get all the items, see MyItems public ITypedItem MyItem { get; } Property Value ITypedItem MyItems List of all Items belonging to this Template/Module. This data is edited by the user directly on this specific module. In some cases it can also be a pre-set item configured in the View to be used if the user has not added any data himself. If this view is configured to only have one item, then this list will only contain one item. Otherwise it will have as many items as the editor added. public IEnumerable MyItems { get; } Property Value IEnumerable MyModel Data passed to this Razor template by a caller. This is typical for Razor components which are re-used, and called from other Razor templates using @Html.Partial(\"filename.cshtml\", new { thing = 7 }). public ITypedModel MyModel { get; } Property Value ITypedModel MyPage Information about the current Page (called Tab in DNN). It's especially useful to get current URL Parameters. public ICmsPage MyPage { get; } Property Value ICmsPage MyUser Information about the current user. It's especially useful to see if the user has any kind of Admin privileges. public ICmsUser MyUser { get; } Property Value ICmsUser MyView View-information such as the view Name, Identity or Edition. public ICmsView MyView { get; } Property Value ICmsView Remarks New in v12.02 UniqueKey A unique, random key for the current module. It's recommended for giving DOM elements a unique id for scripts to then access them. It's generated for every content-block, and more reliable than Module.Id since that sometimes results in duplicate keys, if the many blocks are used inside each other. It's generated using a GUID and converted/shortened. In the current version it's 8 characters long, so it has 10^14 combinations, making collisions extremely unlikely. (currently 8 characters) Tip To get a unique key which is based on additional objects such as Entities, use the UniqueKeyWith(params object[]) method. public string UniqueKey { get; } Property Value string Remarks If you get a fresh IKeyService it will also create a new UniqueKey. So your code should usually use the built-in property UniqueKey which comes from the shared ServiceKit Key. Methods AsEntity(ICanBeEntity) Unwraps a dynamic entity or ITypedItem back into the underlying IEntity public IEntity AsEntity(ICanBeEntity thing) Parameters thing ICanBeEntity Returns IEntity A normal IEntity AsItem(object, NoParamOrder, bool?, bool?) Convert something to a ITypedItem. This works for all kinds of IEntitys, IDynamicEntitys as well as Lists/IEnumerables of those. Will always return a single item. If a list is provided, it will return the first item in the list. If null was provided, it will return null. public ITypedItem AsItem(object data, NoParamOrder noParamOrder = default, bool? propsRequired = null, bool? mock = null) Parameters data object An original object which can be converted to a TypedItem, such as a IEntity . noParamOrder NoParamOrder see Convention: Named Parameters propsRequired bool? make the resulting object strict, default true mock bool? Specify that the data is fake/mock data, which should pretend to be an Item. Default is false Returns ITypedItem Remarks New in v16.02 AsItems(object, NoParamOrder, bool?) Convert an object containing a list of Entities or similar to a list of ITypedItems. public IEnumerable AsItems(object list, NoParamOrder noParamOrder = default, bool? propsRequired = null) Parameters list object The original list which is usually a list of IEntity objects. noParamOrder NoParamOrder see Convention: Named Parameters propsRequired bool? make the resulting object strict, default true Returns IEnumerable Remarks New in v16.01 AsList(object, NoParamOrder, bool) Convert a list of Entities or TypedItems into a strongly typed list. Typically, the type will be from your AppCode.Data. public IEnumerable AsList(object source, NoParamOrder protector = default, bool nullIfNull = false) where T : class, ITypedItemWrapper16, ITypedItem, new() Parameters source object the source object - a List/Enumerable of IEntity or ITypedItem protector NoParamOrder see Convention: Named Parameters nullIfNull bool if true will return null when source is null - otherwise a wrapper item with empty-contents Returns IEnumerable Type Parameters T the target type Remarks Release in v17.05 AsStack(params object[]) Create a typed object which will provide all the properties of the things wrapped inside it. The priority is first-object first, so if multiple items have the property, the first in the list will be returned. public ITypedStack AsStack(params object[] items) Parameters items object[] Returns ITypedStack AsTyped(object, NoParamOrder, bool?) Creates a typed object to read the original passed into this function. This is usually used to process objects which the compiler can't know, such as anonymous objects returned from helper code etc. If you have an array of such objects, use AsTypedList(object, NoParamOrder, bool?). public ITyped AsTyped(object original, NoParamOrder noParamOrder = default, bool? propsRequired = null) Parameters original object noParamOrder NoParamOrder see Convention: Named Parameters propsRequired bool? make the resulting object strict, default true Returns ITyped AsTypedList(object, NoParamOrder, bool?) Create a list public IEnumerable AsTypedList(object list, NoParamOrder noParamOrder = default, bool? propsRequired = null) Parameters list object List/Enumerable object containing a bunch of items to make typed noParamOrder NoParamOrder see Convention: Named Parameters propsRequired bool? make the resulting object strict, default true Returns IEnumerable As(object, NoParamOrder, bool) Convert an Entity or TypedItem into a strongly typed object. Typically, the type will be from your AppCode.Data. public T As(object source, NoParamOrder protector = default, bool mock = false) where T : class, ITypedItemWrapper16, ITypedItem, new() Parameters source object the source object - an IEntity or ITypedItem protector NoParamOrder see Convention: Named Parameters mock bool if true will return a fake when source is null - otherwise a wrapper item with empty-contents Returns T Type Parameters T the target type Remarks Released v17.05 GetCode(string, NoParamOrder, string) Create an instance of a class in a .cs code file. Note that the class name in the file must match the file name, so MyHelpers.cs must have a MyHelpers class. public dynamic GetCode(string path, NoParamOrder noParamOrder = default, string className = null) Parameters path string The path, like Helper.cs, ./helper.cs, ../../Helper.cs or /SomeFolderInApp/Helper.cs (new 16.05) noParamOrder NoParamOrder see Convention: Named Parameters className string Optional class name, if it doesn't match the file name (new 16.03) Returns dynamic , Remarks Created in 16.02 className added in 16.03 Ability to give a path beginning with / as app-root in 16.05 In older code there was a similar CreateInstance method GetService() Get a service from the Dependency Injection. The service can come from 2sxc, EAV or the underlying platform (Dnn, Oqtane). public TService GetService() where TService : class Returns TService An object of the type or interface requested, or null if not found in the DI. Type Parameters TService Interface (preferred) or Class which is needed" + "keywords": "Class CodeTyped Namespace Custom.Hybrid Assembly ToSic.Sxc.dll Base class for v16 Typed CSharp files. Use it to create custom CS code in your App. It provides the ServiceKit16 on property Kit which contains all the popular services to create amazing stuff. [PublicApi] public abstract class CodeTyped : CustomCodeBase, ICanDebug, IHasLog Inheritance object ServiceBase ServiceForDynamicCode CustomCodeBase CodeTyped Implements ICanDebug IHasLog Remarks Important: This is very different from Razor12 or Razor14, as it doesn't rely on dynamic code. Be aware of this since the APIs are very different - see Typed Code. Constructors CodeTyped() Main constructor. Doesn't have parameters so it can easily be inherited. protected CodeTyped() Properties AllResources Stack of all Resources in the System, merging Resources of View, App, Site, Global etc. Will retrieve values by priority, with View-Resources being top priority and Preset-Resources being the lowest. Tip If you know that Resources come from the App, you should prefer App.Resources instead. That is faster and helps people reading your code figure out where to change a value. public ITypedStack AllResources { get; } Property Value ITypedStack AllSettings Stack of all Settings in the System, merging Settings of View, App, Site, Global etc. Will retrieve values by priority, with View-Settings being top priority and Preset-Settings being the lowest. Tip If you know that Settings come from the App, you should prefer App.Settings instead. That is faster and helps people reading your code figure out where to change a value. public ITypedStack AllSettings { get; } Property Value ITypedStack App The current App object (with strictly typed Settings/Resources). Use it to access App properties such as Path or any data in the App. public IAppTyped App { get; } Property Value IAppTyped Kit public ServiceKit16 Kit { get; } Property Value ServiceKit16 Link Link helper object to create the correct links public ILinkService Link { get; } Property Value ILinkService A ILinkService object. Log The logger for the current Razor / WebApi which allows you to add logs to Insights. public ICodeLog Log { get; } Property Value ICodeLog MyContext This Context tells you about the environment, such as the current User the Page the View the Site It's supposed to replace direct access to Dnn or Oqtane object in Razor and WebAPI code, allowing hybrid code that works everywhere. public ICmsContext MyContext { get; } Property Value ICmsContext Remarks New in v11.11 MyData All the data which the current Template received, based on the View configuration. There are a few common scenarios: If it's a simple view, then this will just contain streams with the main Item(s) and Header If the view expects no data, it will just contain a Default stream containing no items If the view has a Query behind it, then MyData will have all the streams provided by the Query public IBlockInstance MyData { get; } Property Value IBlockInstance MyHeader The Header-Item belonging to this Template/Module. This data is edited by the user directly on this specific module. In some cases it can also be a pre-set item configured in the View to be used if the user has not added any data himself. public ITypedItem MyHeader { get; } Property Value ITypedItem MyItem The main Item belonging to this Template/Module. This data is edited by the user directly on this specific module. In some cases it can also be a pre-set item configured in the View to be used if the user has not added any data himself. If this view can have a list of items (more than one) then this contains the first item. To get all the items, see MyItems public ITypedItem MyItem { get; } Property Value ITypedItem MyItems List of all Items belonging to this Template/Module. This data is edited by the user directly on this specific module. In some cases it can also be a pre-set item configured in the View to be used if the user has not added any data himself. If this view is configured to only have one item, then this list will only contain one item. Otherwise it will have as many items as the editor added. public IEnumerable MyItems { get; } Property Value IEnumerable MyModel Data passed to this Razor template by a caller. This is typical for Razor components which are re-used, and called from other Razor templates using @Html.Partial(\"filename.cshtml\", new { thing = 7 }). public ITypedModel MyModel { get; } Property Value ITypedModel MyPage Information about the current Page (called Tab in DNN). It's especially useful to get current URL Parameters. public ICmsPage MyPage { get; } Property Value ICmsPage MyUser Information about the current user. It's especially useful to see if the user has any kind of Admin privileges. public ICmsUser MyUser { get; } Property Value ICmsUser MyView View-information such as the view Name, Identity or Edition. public ICmsView MyView { get; } Property Value ICmsView Remarks New in v12.02 UniqueKey A unique, random key for the current module. It's recommended for giving DOM elements a unique id for scripts to then access them. It's generated for every content-block, and more reliable than Module.Id since that sometimes results in duplicate keys, if the many blocks are used inside each other. It's generated using a GUID and converted/shortened. In the current version it's 8 characters long, so it has 10^14 combinations, making collisions extremely unlikely. (currently 8 characters) Tip To get a unique key which is based on additional objects such as Entities, use the UniqueKeyWith(params object[]) method. public string UniqueKey { get; } Property Value string Remarks If you get a fresh IKeyService it will also create a new UniqueKey. So your code should usually use the built-in property UniqueKey which comes from the shared ServiceKit Key. Methods AsEntity(ICanBeEntity) Unwraps a dynamic entity or ITypedItem back into the underlying IEntity public IEntity AsEntity(ICanBeEntity thing) Parameters thing ICanBeEntity Returns IEntity A normal IEntity AsItem(object, NoParamOrder, bool?, bool?) Convert something to a ITypedItem. This works for all kinds of IEntitys, IDynamicEntitys as well as Lists/IEnumerables of those. Will always return a single item. If a list is provided, it will return the first item in the list. If null was provided, it will return null. public ITypedItem AsItem(object data, NoParamOrder noParamOrder = default, bool? propsRequired = null, bool? mock = null) Parameters data object An original object which can be converted to a TypedItem, such as a IEntity . noParamOrder NoParamOrder see Convention: Named Parameters propsRequired bool? make the resulting object strict, default true mock bool? Specify that the data is fake/mock data, which should pretend to be an Item. Default is false Returns ITypedItem Remarks New in v16.02 AsItems(object, NoParamOrder, bool?) Convert an object containing a list of Entities or similar to a list of ITypedItems. public IEnumerable AsItems(object list, NoParamOrder noParamOrder = default, bool? propsRequired = null) Parameters list object The original list which is usually a list of IEntity objects. noParamOrder NoParamOrder see Convention: Named Parameters propsRequired bool? make the resulting object strict, default true Returns IEnumerable Remarks New in v16.01 AsList(object, NoParamOrder, bool) Convert a list of Entities or TypedItems into a strongly typed list. Typically, the type will be from your AppCode.Data. public IEnumerable AsList(object source, NoParamOrder protector = default, bool nullIfNull = false) where T : class, ITypedItemWrapper16, ITypedItem, new() Parameters source object the source object - a List/Enumerable of IEntity or ITypedItem protector NoParamOrder see Convention: Named Parameters nullIfNull bool if true will return null when source is null - otherwise a wrapper item with empty-contents Returns IEnumerable Type Parameters T the target type Remarks Release in v17.05 AsStack(params object[]) Create a typed object which will provide all the properties of the things wrapped inside it. The priority is first-object first, so if multiple items have the property, the first in the list will be returned. public ITypedStack AsStack(params object[] items) Parameters items object[] objects to stack together Returns ITypedStack AsStack(params object[]) Create a custom-typed object which will provide all the properties of the things wrapped inside it. The priority is first-object first, so if multiple items have the property, the first in the list will be returned. public T AsStack(params object[] items) where T : class, ITypedItemWrapper16, ITypedItem, new() Parameters items object[] objects to stack together Returns T Item of the custom type Type Parameters T Remarks New in 17.07 AsTyped(object, NoParamOrder, bool?) Creates a typed object to read the original passed into this function. This is usually used to process objects which the compiler can't know, such as anonymous objects returned from helper code etc. If you have an array of such objects, use AsTypedList(object, NoParamOrder, bool?). public ITyped AsTyped(object original, NoParamOrder noParamOrder = default, bool? propsRequired = null) Parameters original object noParamOrder NoParamOrder see Convention: Named Parameters propsRequired bool? make the resulting object strict, default true Returns ITyped AsTypedList(object, NoParamOrder, bool?) Create a list public IEnumerable AsTypedList(object list, NoParamOrder noParamOrder = default, bool? propsRequired = null) Parameters list object List/Enumerable object containing a bunch of items to make typed noParamOrder NoParamOrder see Convention: Named Parameters propsRequired bool? make the resulting object strict, default true Returns IEnumerable As(object, NoParamOrder, bool) Convert an Entity or TypedItem into a strongly typed object. Typically, the type will be from your AppCode.Data. public T As(object source, NoParamOrder protector = default, bool mock = false) where T : class, ITypedItemWrapper16, ITypedItem, new() Parameters source object the source object - an IEntity or ITypedItem protector NoParamOrder see Convention: Named Parameters mock bool if true will return a fake when source is null - otherwise a wrapper item with empty-contents Returns T Type Parameters T the target type Remarks Released v17.05 GetCode(string, NoParamOrder, string) Create an instance of a class in a .cs code file. Note that the class name in the file must match the file name, so MyHelpers.cs must have a MyHelpers class. public dynamic GetCode(string path, NoParamOrder noParamOrder = default, string className = null) Parameters path string The path, like Helper.cs, ./helper.cs, ../../Helper.cs or /SomeFolderInApp/Helper.cs (new 16.05) noParamOrder NoParamOrder see Convention: Named Parameters className string Optional class name, if it doesn't match the file name (new 16.03) Returns dynamic , Remarks Created in 16.02 className added in 16.03 Ability to give a path beginning with / as app-root in 16.05 In older code there was a similar CreateInstance method GetService() Get a service from the Dependency Injection. The service can come from 2sxc, EAV or the underlying platform (Dnn, Oqtane). public TService GetService() where TService : class Returns TService An object of the type or interface requested, or null if not found in the DI. Type Parameters TService Interface (preferred) or Class which is needed" }, "api/dot-net/Custom.Hybrid.Razor12.html": { "href": "api/dot-net/Custom.Hybrid.Razor12.html", @@ -912,12 +912,12 @@ "api/dot-net/Custom.Hybrid.RazorTyped-1.html": { "href": "api/dot-net/Custom.Hybrid.RazorTyped-1.html", "title": "Class RazorTyped | 2sxc 17 for Dnn and Oqtane", - "keywords": "Class RazorTyped Namespace Custom.Hybrid Assembly ToSic.Sxc.Dnn.Razor.dll New base class with custom model. The rest of this is identical to RazorTyped. [PublicApi] public abstract class RazorTyped : RazorTyped, IHasLog Type Parameters TModel Model type - eg string or a class from your AppCode Inheritance object WebPageExecutingBase WebPageRenderingBase WebPageBase RazorComponentBase RazorTyped RazorTyped Implements IHasLog Inherited Members RazorTyped.GetService() RazorTyped.Kit RazorTyped.Customize RazorTyped.Log RazorTyped.Html RazorTyped.GetCode(string, NoParamOrder, string) RazorTyped.Link RazorTyped.App RazorTyped.AllResources RazorTyped.AllSettings RazorTyped.MyItem RazorTyped.MyItems RazorTyped.MyHeader RazorTyped.MyData RazorTyped.MyModel RazorTyped.MyContext RazorTyped.MyPage RazorTyped.MyUser RazorTyped.MyView RazorTyped.UniqueKey RazorTyped.AsItem(object, NoParamOrder, bool?, bool?) RazorTyped.AsItems(object, NoParamOrder, bool?) RazorTyped.AsEntity(ICanBeEntity) RazorTyped.AsTyped(object, NoParamOrder, bool?) RazorTyped.AsTypedList(object, NoParamOrder, bool?) RazorTyped.AsStack(params object[]) RazorTyped.As(object, NoParamOrder, bool) RazorTyped.AsList(object, NoParamOrder, bool) Remarks Introduced in v17.03 Properties Model The model for this Razor file. Typed according to the @inherits statement. public TModel Model { get; } Property Value TModel" + "keywords": "Class RazorTyped Namespace Custom.Hybrid Assembly ToSic.Sxc.Dnn.Razor.dll New base class with custom model. The rest of this is identical to RazorTyped. [PublicApi] public abstract class RazorTyped : RazorTyped, IHasLog Type Parameters TModel Model type - eg string or a class from your AppCode Inheritance object WebPageExecutingBase WebPageRenderingBase WebPageBase RazorComponentBase RazorTyped RazorTyped Implements IHasLog Inherited Members RazorTyped.GetService() RazorTyped.Kit RazorTyped.Customize RazorTyped.Log RazorTyped.Html RazorTyped.GetCode(string, NoParamOrder, string) RazorTyped.Link RazorTyped.App RazorTyped.AllResources RazorTyped.AllSettings RazorTyped.MyItem RazorTyped.MyItems RazorTyped.MyHeader RazorTyped.MyData RazorTyped.MyModel RazorTyped.MyContext RazorTyped.MyPage RazorTyped.MyUser RazorTyped.MyView RazorTyped.UniqueKey RazorTyped.AsItem(object, NoParamOrder, bool?, bool?) RazorTyped.AsItems(object, NoParamOrder, bool?) RazorTyped.AsEntity(ICanBeEntity) RazorTyped.AsTyped(object, NoParamOrder, bool?) RazorTyped.AsTypedList(object, NoParamOrder, bool?) RazorTyped.AsStack(params object[]) RazorTyped.AsStack(params object[]) RazorTyped.As(object, NoParamOrder, bool) RazorTyped.AsList(object, NoParamOrder, bool) Remarks Introduced in v17.03 Properties Model The model for this Razor file. Typed according to the @inherits statement. public TModel Model { get; } Property Value TModel" }, "api/dot-net/Custom.Hybrid.RazorTyped.html": { "href": "api/dot-net/Custom.Hybrid.RazorTyped.html", "title": "Class RazorTyped | 2sxc 17 for Dnn and Oqtane", - "keywords": "Class RazorTyped Namespace Custom.Hybrid Assembly ToSic.Sxc.Dnn.Razor.dll Base class for v16 Typed Razor files. Use it to create custom CS code in your App. It provides the ServiceKit16 on property Kit which contains all the popular services to create amazing stuff. [PublicApi] public abstract class RazorTyped : RazorComponentBase, IHasLog Inheritance object WebPageExecutingBase WebPageRenderingBase WebPageBase RazorComponentBase RazorTyped Implements IHasLog Derived RazorTyped Remarks Important: This is very different from Razor12 or Razor14, as it doesn't rely on dynamic code. Be aware of this since the APIs are very different - see Typed Code. Properties AllResources Stack of all Resources in the System, merging Resources of View, App, Site, Global etc. Will retrieve values by priority, with View-Resources being top priority and Preset-Resources being the lowest. Tip If you know that Resources come from the App, you should prefer App.Resources instead. That is faster and helps people reading your code figure out where to change a value. public ITypedStack AllResources { get; } Property Value ITypedStack AllSettings Stack of all Settings in the System, merging Settings of View, App, Site, Global etc. Will retrieve values by priority, with View-Settings being top priority and Preset-Settings being the lowest. Tip If you know that Settings come from the App, you should prefer App.Settings instead. That is faster and helps people reading your code figure out where to change a value. public ITypedStack AllSettings { get; } Property Value ITypedStack App The current App object (with strictly typed Settings/Resources). Use it to access App properties such as Path or any data in the App. public IAppTyped App { get; } Property Value IAppTyped Customize BETA! v17.03+ [WorkInProgressApi(\"Experiment v17.03+\")] protected ICodeCustomizer Customize { get; } Property Value ICodeCustomizer Html Helper for Html.Raw - for creating raw html output which doesn't encode > and <. Also has helpers such as .Partial(...) public override IHtmlHelper Html { get; } Property Value IHtmlHelper Kit public ServiceKit16 Kit { get; } Property Value ServiceKit16 Link Link helper object to create the correct links public ILinkService Link { get; } Property Value ILinkService A ILinkService object. Log The logger for the current Razor / WebApi which allows you to add logs to Insights. public override ICodeLog Log { get; } Property Value ICodeLog MyContext This Context tells you about the environment, such as the current User the Page the View the Site It's supposed to replace direct access to Dnn or Oqtane object in Razor and WebAPI code, allowing hybrid code that works everywhere. public ICmsContext MyContext { get; } Property Value ICmsContext Remarks New in v11.11 MyData All the data which the current Template received, based on the View configuration. There are a few common scenarios: If it's a simple view, then this will just contain streams with the main Item(s) and Header If the view expects no data, it will just contain a Default stream containing no items If the view has a Query behind it, then MyData will have all the streams provided by the Query public IBlockInstance MyData { get; } Property Value IBlockInstance MyHeader The Header-Item belonging to this Template/Module. This data is edited by the user directly on this specific module. In some cases it can also be a pre-set item configured in the View to be used if the user has not added any data himself. public ITypedItem MyHeader { get; } Property Value ITypedItem MyItem The main Item belonging to this Template/Module. This data is edited by the user directly on this specific module. In some cases it can also be a pre-set item configured in the View to be used if the user has not added any data himself. If this view can have a list of items (more than one) then this contains the first item. To get all the items, see MyItems public ITypedItem MyItem { get; } Property Value ITypedItem MyItems List of all Items belonging to this Template/Module. This data is edited by the user directly on this specific module. In some cases it can also be a pre-set item configured in the View to be used if the user has not added any data himself. If this view is configured to only have one item, then this list will only contain one item. Otherwise it will have as many items as the editor added. public IEnumerable MyItems { get; } Property Value IEnumerable MyModel Data passed to this Razor template by a caller. This is typical for Razor components which are re-used, and called from other Razor templates using @Html.Partial(\"filename.cshtml\", new { thing = 7 }). public ITypedModel MyModel { get; } Property Value ITypedModel MyPage Information about the current Page (called Tab in DNN). It's especially useful to get current URL Parameters. public ICmsPage MyPage { get; } Property Value ICmsPage MyUser Information about the current user. It's especially useful to see if the user has any kind of Admin privileges. public ICmsUser MyUser { get; } Property Value ICmsUser MyView View-information such as the view Name, Identity or Edition. public ICmsView MyView { get; } Property Value ICmsView Remarks New in v12.02 UniqueKey A unique, random key for the current module. It's recommended for giving DOM elements a unique id for scripts to then access them. It's generated for every content-block, and more reliable than Module.Id since that sometimes results in duplicate keys, if the many blocks are used inside each other. It's generated using a GUID and converted/shortened. In the current version it's 8 characters long, so it has 10^14 combinations, making collisions extremely unlikely. (currently 8 characters) Tip To get a unique key which is based on additional objects such as Entities, use the UniqueKeyWith(params object[]) method. public string UniqueKey { get; } Property Value string Remarks If you get a fresh IKeyService it will also create a new UniqueKey. So your code should usually use the built-in property UniqueKey which comes from the shared ServiceKit Key. Methods AsEntity(ICanBeEntity) Unwraps a dynamic entity or ITypedItem back into the underlying IEntity public IEntity AsEntity(ICanBeEntity thing) Parameters thing ICanBeEntity Returns IEntity A normal IEntity AsItem(object, NoParamOrder, bool?, bool?) Convert something to a ITypedItem. This works for all kinds of IEntitys, IDynamicEntitys as well as Lists/IEnumerables of those. Will always return a single item. If a list is provided, it will return the first item in the list. If null was provided, it will return null. public ITypedItem AsItem(object data, NoParamOrder noParamOrder = default, bool? propsRequired = null, bool? mock = null) Parameters data object An original object which can be converted to a TypedItem, such as a IEntity . noParamOrder NoParamOrder see Convention: Named Parameters propsRequired bool? make the resulting object strict, default true mock bool? Specify that the data is fake/mock data, which should pretend to be an Item. Default is false Returns ITypedItem Remarks New in v16.02 AsItems(object, NoParamOrder, bool?) Convert an object containing a list of Entities or similar to a list of ITypedItems. public IEnumerable AsItems(object list, NoParamOrder noParamOrder = default, bool? propsRequired = null) Parameters list object The original list which is usually a list of IEntity objects. noParamOrder NoParamOrder see Convention: Named Parameters propsRequired bool? make the resulting object strict, default true Returns IEnumerable Remarks New in v16.01 AsList(object, NoParamOrder, bool) Convert a list of Entities or TypedItems into a strongly typed list. Typically, the type will be from your AppCode.Data. public IEnumerable AsList(object source, NoParamOrder protector = default, bool nullIfNull = false) where T : class, ITypedItemWrapper16, ITypedItem, new() Parameters source object the source object - a List/Enumerable of IEntity or ITypedItem protector NoParamOrder see Convention: Named Parameters nullIfNull bool if true will return null when source is null - otherwise a wrapper item with empty-contents Returns IEnumerable Type Parameters T the target type Remarks Release in v17.05 AsStack(params object[]) Create a typed object which will provide all the properties of the things wrapped inside it. The priority is first-object first, so if multiple items have the property, the first in the list will be returned. public ITypedStack AsStack(params object[] items) Parameters items object[] Returns ITypedStack AsTyped(object, NoParamOrder, bool?) Creates a typed object to read the original passed into this function. This is usually used to process objects which the compiler can't know, such as anonymous objects returned from helper code etc. If you have an array of such objects, use AsTypedList(object, NoParamOrder, bool?). public ITyped AsTyped(object original, NoParamOrder noParamOrder = default, bool? propsRequired = null) Parameters original object noParamOrder NoParamOrder see Convention: Named Parameters propsRequired bool? make the resulting object strict, default true Returns ITyped AsTypedList(object, NoParamOrder, bool?) Create a list public IEnumerable AsTypedList(object list, NoParamOrder noParamOrder = default, bool? propsRequired = null) Parameters list object List/Enumerable object containing a bunch of items to make typed noParamOrder NoParamOrder see Convention: Named Parameters propsRequired bool? make the resulting object strict, default true Returns IEnumerable As(object, NoParamOrder, bool) Convert an Entity or TypedItem into a strongly typed object. Typically, the type will be from your AppCode.Data. public T As(object source, NoParamOrder protector = default, bool mock = false) where T : class, ITypedItemWrapper16, ITypedItem, new() Parameters source object the source object - an IEntity or ITypedItem protector NoParamOrder see Convention: Named Parameters mock bool if true will return a fake when source is null - otherwise a wrapper item with empty-contents Returns T Type Parameters T the target type Remarks Released v17.05 GetCode(string, NoParamOrder, string) Create an instance of a class in a .cs code file. Note that the class name in the file must match the file name, so MyHelpers.cs must have a MyHelpers class. public dynamic GetCode(string path, NoParamOrder noParamOrder = default, string className = null) Parameters path string The path, like Helper.cs, ./helper.cs, ../../Helper.cs or /SomeFolderInApp/Helper.cs (new 16.05) noParamOrder NoParamOrder see Convention: Named Parameters className string Optional class name, if it doesn't match the file name (new 16.03) Returns dynamic , Remarks Created in 16.02 className added in 16.03 Ability to give a path beginning with / as app-root in 16.05 In older code there was a similar CreateInstance method GetService() Get a service from the Dependency Injection. The service can come from 2sxc, EAV or the underlying platform (Dnn, Oqtane). public TService GetService() where TService : class Returns TService An object of the type or interface requested, or null if not found in the DI. Type Parameters TService Interface (preferred) or Class which is needed" + "keywords": "Class RazorTyped Namespace Custom.Hybrid Assembly ToSic.Sxc.Dnn.Razor.dll Base class for v16 Typed Razor files. Use it to create custom CS code in your App. It provides the ServiceKit16 on property Kit which contains all the popular services to create amazing stuff. [PublicApi] public abstract class RazorTyped : RazorComponentBase, IHasLog Inheritance object WebPageExecutingBase WebPageRenderingBase WebPageBase RazorComponentBase RazorTyped Implements IHasLog Derived RazorTyped Remarks Important: This is very different from Razor12 or Razor14, as it doesn't rely on dynamic code. Be aware of this since the APIs are very different - see Typed Code. Properties AllResources Stack of all Resources in the System, merging Resources of View, App, Site, Global etc. Will retrieve values by priority, with View-Resources being top priority and Preset-Resources being the lowest. Tip If you know that Resources come from the App, you should prefer App.Resources instead. That is faster and helps people reading your code figure out where to change a value. public ITypedStack AllResources { get; } Property Value ITypedStack AllSettings Stack of all Settings in the System, merging Settings of View, App, Site, Global etc. Will retrieve values by priority, with View-Settings being top priority and Preset-Settings being the lowest. Tip If you know that Settings come from the App, you should prefer App.Settings instead. That is faster and helps people reading your code figure out where to change a value. public ITypedStack AllSettings { get; } Property Value ITypedStack App The current App object (with strictly typed Settings/Resources). Use it to access App properties such as Path or any data in the App. public IAppTyped App { get; } Property Value IAppTyped Customize BETA! v17.03+ [WorkInProgressApi(\"Experiment v17.03+\")] protected ICodeCustomizer Customize { get; } Property Value ICodeCustomizer Html Helper for Html.Raw - for creating raw html output which doesn't encode > and <. Also has helpers such as .Partial(...) public override IHtmlHelper Html { get; } Property Value IHtmlHelper Kit public ServiceKit16 Kit { get; } Property Value ServiceKit16 Link Link helper object to create the correct links public ILinkService Link { get; } Property Value ILinkService A ILinkService object. Log The logger for the current Razor / WebApi which allows you to add logs to Insights. public override ICodeLog Log { get; } Property Value ICodeLog MyContext This Context tells you about the environment, such as the current User the Page the View the Site It's supposed to replace direct access to Dnn or Oqtane object in Razor and WebAPI code, allowing hybrid code that works everywhere. public ICmsContext MyContext { get; } Property Value ICmsContext Remarks New in v11.11 MyData All the data which the current Template received, based on the View configuration. There are a few common scenarios: If it's a simple view, then this will just contain streams with the main Item(s) and Header If the view expects no data, it will just contain a Default stream containing no items If the view has a Query behind it, then MyData will have all the streams provided by the Query public IBlockInstance MyData { get; } Property Value IBlockInstance MyHeader The Header-Item belonging to this Template/Module. This data is edited by the user directly on this specific module. In some cases it can also be a pre-set item configured in the View to be used if the user has not added any data himself. public ITypedItem MyHeader { get; } Property Value ITypedItem MyItem The main Item belonging to this Template/Module. This data is edited by the user directly on this specific module. In some cases it can also be a pre-set item configured in the View to be used if the user has not added any data himself. If this view can have a list of items (more than one) then this contains the first item. To get all the items, see MyItems public ITypedItem MyItem { get; } Property Value ITypedItem MyItems List of all Items belonging to this Template/Module. This data is edited by the user directly on this specific module. In some cases it can also be a pre-set item configured in the View to be used if the user has not added any data himself. If this view is configured to only have one item, then this list will only contain one item. Otherwise it will have as many items as the editor added. public IEnumerable MyItems { get; } Property Value IEnumerable MyModel Data passed to this Razor template by a caller. This is typical for Razor components which are re-used, and called from other Razor templates using @Html.Partial(\"filename.cshtml\", new { thing = 7 }). public ITypedModel MyModel { get; } Property Value ITypedModel MyPage Information about the current Page (called Tab in DNN). It's especially useful to get current URL Parameters. public ICmsPage MyPage { get; } Property Value ICmsPage MyUser Information about the current user. It's especially useful to see if the user has any kind of Admin privileges. public ICmsUser MyUser { get; } Property Value ICmsUser MyView View-information such as the view Name, Identity or Edition. public ICmsView MyView { get; } Property Value ICmsView Remarks New in v12.02 UniqueKey A unique, random key for the current module. It's recommended for giving DOM elements a unique id for scripts to then access them. It's generated for every content-block, and more reliable than Module.Id since that sometimes results in duplicate keys, if the many blocks are used inside each other. It's generated using a GUID and converted/shortened. In the current version it's 8 characters long, so it has 10^14 combinations, making collisions extremely unlikely. (currently 8 characters) Tip To get a unique key which is based on additional objects such as Entities, use the UniqueKeyWith(params object[]) method. public string UniqueKey { get; } Property Value string Remarks If you get a fresh IKeyService it will also create a new UniqueKey. So your code should usually use the built-in property UniqueKey which comes from the shared ServiceKit Key. Methods AsEntity(ICanBeEntity) Unwraps a dynamic entity or ITypedItem back into the underlying IEntity public IEntity AsEntity(ICanBeEntity thing) Parameters thing ICanBeEntity Returns IEntity A normal IEntity AsItem(object, NoParamOrder, bool?, bool?) Convert something to a ITypedItem. This works for all kinds of IEntitys, IDynamicEntitys as well as Lists/IEnumerables of those. Will always return a single item. If a list is provided, it will return the first item in the list. If null was provided, it will return null. public ITypedItem AsItem(object data, NoParamOrder noParamOrder = default, bool? propsRequired = null, bool? mock = null) Parameters data object An original object which can be converted to a TypedItem, such as a IEntity . noParamOrder NoParamOrder see Convention: Named Parameters propsRequired bool? make the resulting object strict, default true mock bool? Specify that the data is fake/mock data, which should pretend to be an Item. Default is false Returns ITypedItem Remarks New in v16.02 AsItems(object, NoParamOrder, bool?) Convert an object containing a list of Entities or similar to a list of ITypedItems. public IEnumerable AsItems(object list, NoParamOrder noParamOrder = default, bool? propsRequired = null) Parameters list object The original list which is usually a list of IEntity objects. noParamOrder NoParamOrder see Convention: Named Parameters propsRequired bool? make the resulting object strict, default true Returns IEnumerable Remarks New in v16.01 AsList(object, NoParamOrder, bool) Convert a list of Entities or TypedItems into a strongly typed list. Typically, the type will be from your AppCode.Data. public IEnumerable AsList(object source, NoParamOrder protector = default, bool nullIfNull = false) where T : class, ITypedItemWrapper16, ITypedItem, new() Parameters source object the source object - a List/Enumerable of IEntity or ITypedItem protector NoParamOrder see Convention: Named Parameters nullIfNull bool if true will return null when source is null - otherwise a wrapper item with empty-contents Returns IEnumerable Type Parameters T the target type Remarks Release in v17.05 AsStack(params object[]) Create a typed object which will provide all the properties of the things wrapped inside it. The priority is first-object first, so if multiple items have the property, the first in the list will be returned. public ITypedStack AsStack(params object[] items) Parameters items object[] objects to stack together Returns ITypedStack AsStack(params object[]) Create a custom-typed object which will provide all the properties of the things wrapped inside it. The priority is first-object first, so if multiple items have the property, the first in the list will be returned. public T AsStack(params object[] items) where T : class, ITypedItemWrapper16, ITypedItem, new() Parameters items object[] objects to stack together Returns T Item of the custom type Type Parameters T Remarks New in 17.07 AsTyped(object, NoParamOrder, bool?) Creates a typed object to read the original passed into this function. This is usually used to process objects which the compiler can't know, such as anonymous objects returned from helper code etc. If you have an array of such objects, use AsTypedList(object, NoParamOrder, bool?). public ITyped AsTyped(object original, NoParamOrder noParamOrder = default, bool? propsRequired = null) Parameters original object noParamOrder NoParamOrder see Convention: Named Parameters propsRequired bool? make the resulting object strict, default true Returns ITyped AsTypedList(object, NoParamOrder, bool?) Create a list public IEnumerable AsTypedList(object list, NoParamOrder noParamOrder = default, bool? propsRequired = null) Parameters list object List/Enumerable object containing a bunch of items to make typed noParamOrder NoParamOrder see Convention: Named Parameters propsRequired bool? make the resulting object strict, default true Returns IEnumerable As(object, NoParamOrder, bool) Convert an Entity or TypedItem into a strongly typed object. Typically, the type will be from your AppCode.Data. public T As(object source, NoParamOrder protector = default, bool mock = false) where T : class, ITypedItemWrapper16, ITypedItem, new() Parameters source object the source object - an IEntity or ITypedItem protector NoParamOrder see Convention: Named Parameters mock bool if true will return a fake when source is null - otherwise a wrapper item with empty-contents Returns T Type Parameters T the target type Remarks Released v17.05 GetCode(string, NoParamOrder, string) Create an instance of a class in a .cs code file. Note that the class name in the file must match the file name, so MyHelpers.cs must have a MyHelpers class. public dynamic GetCode(string path, NoParamOrder noParamOrder = default, string className = null) Parameters path string The path, like Helper.cs, ./helper.cs, ../../Helper.cs or /SomeFolderInApp/Helper.cs (new 16.05) noParamOrder NoParamOrder see Convention: Named Parameters className string Optional class name, if it doesn't match the file name (new 16.03) Returns dynamic , Remarks Created in 16.02 className added in 16.03 Ability to give a path beginning with / as app-root in 16.05 In older code there was a similar CreateInstance method GetService() Get a service from the Dependency Injection. The service can come from 2sxc, EAV or the underlying platform (Dnn, Oqtane). public TService GetService() where TService : class Returns TService An object of the type or interface requested, or null if not found in the DI. Type Parameters TService Interface (preferred) or Class which is needed" }, "api/dot-net/Custom.Hybrid.html": { "href": "api/dot-net/Custom.Hybrid.html", @@ -2032,7 +2032,7 @@ "api/dot-net/ToSic.Sxc.Data.IMetadata.html": { "href": "api/dot-net/ToSic.Sxc.Data.IMetadata.html", "title": "Interface IMetadata | 2sxc 17 for Dnn and Oqtane", - "keywords": "Interface IMetadata Namespace ToSic.Sxc.Data Assembly ToSic.Sxc.dll Metadata on Dynamic Objects - like IDynamicEntity or IAsset (files/folders). Behaves like a normal DynamicEntity, but has additional commands to detect if specific Metadata exists. [PublicApi] public interface IMetadata : IHasMetadata, ITypedItem, ITyped, IEquatable, ICanDebug, IHasDecorators Inherited Members IHasMetadata.Metadata ITypedItem.Dyn ITypedItem.Presentation ITypedItem.Field(string, NoParamOrder, bool?) ITypedItem.Folder(string, NoParamOrder, bool?) ITypedItem.File(string, NoParamOrder, bool?) ITypedItem.Child(string, NoParamOrder, bool?) ITypedItem.Children(string, NoParamOrder, string, bool?) ITypedItem.Parent(NoParamOrder, bool?, string, string) ITypedItem.Parents(NoParamOrder, string, string) ITypedItem.Child(string, NoParamOrder, bool?) ITypedItem.Children(string, NoParamOrder, string, bool?) ITypedItem.Parent(NoParamOrder, bool?, string, string) ITypedItem.Parents(NoParamOrder, string, string) ITypedItem.IsPublished ITypedItem.Publishing ITypedItem.IsDemoItem ITypedItem.Html(string, NoParamOrder, object, bool?, object, bool?, bool, Func, ITweakInput>) ITypedItem.Picture(string, NoParamOrder, object, object, object, string, string, string, object, string, object, object, object) ITypedItem.Img(string, NoParamOrder, object, object, object, string, string, string, object, object, object) ITypedItem.Id ITypedItem.Guid ITypedItem.Title ITypedItem.Type ITyped.Bool(string, NoParamOrder, bool, bool?) ITyped.DateTime(string, NoParamOrder, DateTime, bool?) ITyped.String(string, NoParamOrder, string, bool?, object) ITyped.Int(string, NoParamOrder, int, bool?) ITyped.Long(string, NoParamOrder, long, bool?) ITyped.Float(string, NoParamOrder, float, bool?) ITyped.Decimal(string, NoParamOrder, decimal, bool?) ITyped.Double(string, NoParamOrder, double, bool?) ITyped.Url(string, NoParamOrder, string, bool?) ITyped.Attribute(string, NoParamOrder, string, bool?) ITyped.ContainsKey(string) ITyped.IsEmpty(string, NoParamOrder) ITyped.IsNotEmpty(string, NoParamOrder) ITyped.Keys(NoParamOrder, IEnumerable) ITyped.Get(string, NoParamOrder, bool?) ITyped.Get(string, NoParamOrder, TValue, bool?) IEquatable.Equals(ITypedItem) ICanDebug.Debug IHasDecorators.Decorators Remarks Added in v13 Made compatible to ITypedItem in 16.02 to allow typed commands such as .String(...) Renamed in v16.02 from IDynamicMetadata to IMetadata since it's not necessarily dynamic any more (but still supports dynamic where needed) Note that this is a breaking change, but we believe the type is never directly mentioned in any code Methods HasType(string) Ask if there is metadata of the type specified. This is important in scenarios where an item could have a lot of metadata, but we only want one specific type to look at. bool HasType(string type) Parameters type string Returns bool true if metadata of that type exists OfType(string) Get all the metadata Entities of a specific type. IEnumerable OfType(string type) Parameters type string Returns IEnumerable" + "keywords": "Interface IMetadata Namespace ToSic.Sxc.Data Assembly ToSic.Sxc.dll Metadata on Dynamic Objects - like IDynamicEntity or IAsset (files/folders). Behaves like a normal DynamicEntity, but has additional commands to detect if specific Metadata exists. [PublicApi] public interface IMetadata : IHasMetadata, ITypedItem, ITyped, IEquatable, ICanDebug, IHasDecorators Inherited Members IHasMetadata.Metadata ITypedItem.Dyn ITypedItem.Presentation ITypedItem.Field(string, NoParamOrder, bool?) ITypedItem.Folder(string, NoParamOrder, bool?) ITypedItem.File(string, NoParamOrder, bool?) ITypedItem.Child(string, NoParamOrder, bool?) ITypedItem.Children(string, NoParamOrder, string, bool?) ITypedItem.Parent(NoParamOrder, bool?, string, string) ITypedItem.Parents(NoParamOrder, string, string) ITypedItem.Child(string, NoParamOrder, bool?) ITypedItem.Children(string, NoParamOrder, string, bool?) ITypedItem.Parent(NoParamOrder, bool?, string, string) ITypedItem.Parents(NoParamOrder, string, string) ITypedItem.IsPublished ITypedItem.Publishing ITypedItem.IsDemoItem ITypedItem.Html(string, NoParamOrder, object, bool?, object, bool?, bool, Func, ITweakInput>) ITypedItem.Picture(string, NoParamOrder, object, object, object, string, string, string, object, string, object, object, object) ITypedItem.Img(string, NoParamOrder, object, object, object, string, string, string, object, object, object) ITypedItem.Gps(string, NoParamOrder, bool?) ITypedItem.Id ITypedItem.Guid ITypedItem.Title ITypedItem.Type ITyped.Bool(string, NoParamOrder, bool, bool?) ITyped.DateTime(string, NoParamOrder, DateTime, bool?) ITyped.String(string, NoParamOrder, string, bool?, object) ITyped.Int(string, NoParamOrder, int, bool?) ITyped.Long(string, NoParamOrder, long, bool?) ITyped.Float(string, NoParamOrder, float, bool?) ITyped.Decimal(string, NoParamOrder, decimal, bool?) ITyped.Double(string, NoParamOrder, double, bool?) ITyped.Url(string, NoParamOrder, string, bool?) ITyped.Attribute(string, NoParamOrder, string, bool?) ITyped.ContainsKey(string) ITyped.IsEmpty(string, NoParamOrder) ITyped.IsNotEmpty(string, NoParamOrder) ITyped.Keys(NoParamOrder, IEnumerable) ITyped.Get(string, NoParamOrder, bool?) ITyped.Get(string, NoParamOrder, TValue, bool?) IEquatable.Equals(ITypedItem) ICanDebug.Debug IHasDecorators.Decorators Remarks Added in v13 Made compatible to ITypedItem in 16.02 to allow typed commands such as .String(...) Renamed in v16.02 from IDynamicMetadata to IMetadata since it's not necessarily dynamic any more (but still supports dynamic where needed) Note that this is a breaking change, but we believe the type is never directly mentioned in any code Methods HasType(string) Ask if there is metadata of the type specified. This is important in scenarios where an item could have a lot of metadata, but we only want one specific type to look at. bool HasType(string type) Parameters type string Returns bool true if metadata of that type exists OfType(string) Get all the metadata Entities of a specific type. IEnumerable OfType(string type) Parameters type string Returns IEnumerable" }, "api/dot-net/ToSic.Sxc.Data.IPublishing.html": { "href": "api/dot-net/ToSic.Sxc.Data.IPublishing.html", @@ -2052,17 +2052,17 @@ "api/dot-net/ToSic.Sxc.Data.ITypedItem.html": { "href": "api/dot-net/ToSic.Sxc.Data.ITypedItem.html", "title": "Interface ITypedItem | 2sxc 17 for Dnn and Oqtane", - "keywords": "Interface ITypedItem Namespace ToSic.Sxc.Data Assembly ToSic.Sxc.dll A typed object to access data. Previously Razor code always used dynamic IDynamicEntity objects. This had some disadvantages when working with LINQ or advanced toolbars. [PublicApi] [JsonConverter(typeof(DynamicJsonConverter))] public interface ITypedItem : ITyped, IEquatable Inherited Members ITyped.Bool(string, NoParamOrder, bool, bool?) ITyped.DateTime(string, NoParamOrder, DateTime, bool?) ITyped.String(string, NoParamOrder, string, bool?, object) ITyped.Int(string, NoParamOrder, int, bool?) ITyped.Long(string, NoParamOrder, long, bool?) ITyped.Float(string, NoParamOrder, float, bool?) ITyped.Decimal(string, NoParamOrder, decimal, bool?) ITyped.Double(string, NoParamOrder, double, bool?) ITyped.Url(string, NoParamOrder, string, bool?) ITyped.Attribute(string, NoParamOrder, string, bool?) ITyped.ContainsKey(string) ITyped.IsEmpty(string, NoParamOrder) ITyped.IsNotEmpty(string, NoParamOrder) ITyped.Keys(NoParamOrder, IEnumerable) ITyped.Get(string, NoParamOrder, bool?) ITyped.Get(string, NoParamOrder, TValue, bool?) IEquatable.Equals(ITypedItem) Remarks Introduced in 2sxc 16.01 Properties Dyn A dynamic accessor for properties, to quickly get values when you don't care about type safety. This is often (but not always) a IDynamicEntity. Example: Dyn.FirstName might just work - and return the first name or null if not found. dynamic Dyn { get; } Property Value dynamic Guid The guid of the underlying entity. Guid Guid { get; } Property Value Guid Remarks If the entity doesn't exist, it will return an empty guid Id The ID of the underlying entity. Use it for edit-functionality or just to have a unique number for this item. int Id { get; } Property Value int Remarks If the entity doesn't exist, it will return 0 IsDemoItem Many templates show demo data. If the template code must know if it's the demo item or real data, use .IsDemoItem. bool IsDemoItem { get; } Property Value bool True if this is the item configured in the view-settings, false if not. IsPublished True if this item version is published. This means that the item can exist as published, or published-with-draft, showing the published version. Note that by default, end-users only see the published version and don't see any draft version. bool IsPublished { get; } Property Value bool Remarks New in v17, see also Publishing Metadata Metadata of the current item, with special features. IMetadata Metadata { get; } Property Value IMetadata Remarks Added in 16.02 Presentation The presentation item or null if it doesn't exist. ITypedItem Presentation { get; } Property Value ITypedItem Publishing IPublishing Publishing { get; } Property Value IPublishing Title The title of this item. This is always available no matter what the underlying field for the title is. string Title { get; } Property Value string The title of the underlying entity. In rare cases where no title-field is known, it can be null. It can also be null if there is no underlying entity. Remarks This returns a string which is usually what's expected. In previous versions (before v15) 2sxc it returned an object. Type The Content-Type of the current entity. IContentType Type { get; } Property Value IContentType Methods Child(string, NoParamOrder, bool?) A single item from a field. ITypedItem Child(string name, NoParamOrder noParamOrder = default, bool? required = null) Parameters name string Name of the field noParamOrder NoParamOrder see Convention: Named Parameters required bool? throw error if name doesn't exist, see Convention: Property Required Name Checks Returns ITypedItem The ITypedItem. If the field doesn't exist or is empty, will return null. Child(string, NoParamOrder, bool?) Get a child and return with specified custom type. T Child(string name = null, NoParamOrder protector = default, bool? required = null) where T : class, ITypedItemWrapper16, ITypedItem, new() Parameters name string Name of the field protector NoParamOrder see Convention: Named Parameters required bool? throw error if name doesn't exist, see Convention: Property Required Name Checks Returns T Type Parameters T Remarks New v17.05 Children(string, NoParamOrder, string, bool?) A typed list of sub-items. Important for LINQ style querying or just working with various lists. Note that for getting child items of this item you can just use the properties, like content.Authors. But using Children(\"Authors\", type: typeName) gives you the ability to restrict to a type. Please check the tutorials on 2sxc.org/dnn-tutorials/ for more info. IEnumerable Children(string field = null, NoParamOrder noParamOrder = default, string type = null, bool? required = null) Parameters field string Optional field filter - would only return items that point to the current item in a specific field name. noParamOrder NoParamOrder see Convention: Named Parameters type string Optional type filter - would only return items of this type. required bool? throw error if name doesn't exist, see Convention: Property Required Name Checks Returns IEnumerable A list of all items pointing here (filtered), converted to DynamicEntity for convenience. Remarks Note that the parameter-order is reversed to the Parents() Children(string, NoParamOrder, string, bool?) A strongly typed list of sub-items. Important for LINQ style querying or just working with various lists. Note that for getting child items of this item you can just use the properties, like content.Authors. But using Children(\"Authors\", type: typeName) gives you the ability to restrict to a type. Please check the tutorials on 2sxc.org/dnn-tutorials/ for more info. IEnumerable Children(string field = null, NoParamOrder protector = default, string type = null, bool? required = null) where T : class, ITypedItemWrapper16, ITypedItem, new() Parameters field string Name of the field protector NoParamOrder see Convention: Named Parameters type string Optional type filter - would only return items of this type. required bool? throw error if name doesn't exist, see Convention: Property Required Name Checks Returns IEnumerable Type Parameters T Remarks New v17.05 Field(string, NoParamOrder, bool?) Get a special info-object describing a specific field in this item. This is a rich object used by other operations which need a lot of context about the item and the field. IField Field(string name, NoParamOrder noParamOrder = default, bool? required = null) Parameters name string Name of the property noParamOrder NoParamOrder see Convention: Named Parameters required bool? throw error if name doesn't exist, see Convention: Property Required Name Checks Returns IField File(string, NoParamOrder, bool?) Get the file of the current field. There are a few scenarios: If it's a file/hyperlink field pointing to a file such as file:27 it will retrieve the file itself. If it's a file/hyperlink field pointing to a url such as http://xyz it will return null. If it's a library field, it will just take the first file, as there is no value referencing a specific field If it's any other field, will return null IFile File(string name, NoParamOrder noParamOrder = default, bool? required = null) Parameters name string property name noParamOrder NoParamOrder see Convention: Named Parameters required bool? throw error if name doesn't exist, see Convention: Property Required Name Checks Returns IFile Remarks Added in 16.02 Folder(string, NoParamOrder, bool?) Get the ADAM (Automatic Digital Asset Manager) for this field. This is a folder which contains all the files and possibly folders which are uploaded on exactly this field. IFolder Folder(string name, NoParamOrder noParamOrder = default, bool? required = null) Parameters name string property name noParamOrder NoParamOrder see Convention: Named Parameters required bool? throw error if name doesn't exist, see Convention: Property Required Name Checks Returns IFolder The Folder object Remarks Added in 16.02 Html(string, NoParamOrder, object, bool?, object, bool?, bool, Func, ITweakInput>) Show a field in the expected / best possible way. As of now it's meant for WYSIWYG fields with Very-Rich Text. See DynamicEntity / TypedItem .Html(...) Method new v16.01 IHtmlTag Html(string name, NoParamOrder noParamOrder = default, object container = null, bool? toolbar = null, object imageSettings = null, bool? required = null, bool debug = false, Func, ITweakInput> tweak = null) Parameters name string the field name noParamOrder NoParamOrder see Convention: Named Parameters container object A wrapper tag for the result. It's either a RazorBlade tag such as Kit.HtmlTag.Div(), a string such as span or an empty string `` to indicate no container. If not set it will default to to a div-tag. See docs toolbar bool? Override default toolbar behavior on this field. See docs imageSettings object Settings for resizing. Default is Wysiwyg but it can also be Content or a settings object. required bool? throw error if name doesn't exist, see Convention: Property Required Name Checks debug bool Activate debug visualization to better see alignments and such. tweak Func, ITweakInput> tweak behavior - ATM modify the input before it's processed new in v17 Returns IHtmlTag Remarks Added in 2sxc 16.01 Added tweak in v17 Only works on Razor files inheriting from Hybrid14 or newer Img(string, NoParamOrder, object, object, object, string, string, string, object, object, object) Get a Responsive Picture object which you can then either just show, or use to construct a more customized output as you need it. The resulting object can just be added to the html, like @pic or you can work with sub-properties as specified in the IResponsivePicture. Important: This call only allows you to set the most common parameters factor and width. For other parameters like height, aspectRatio, quality etc. create typed Settings Settings(object, NoParamOrder, object, object, object, object, string, string, string, object, string, object) and pass them in. Note This is the similar as using the Picture(object, object, NoParamOrder, object, object, string, string, string, object, string, object, object, object) just a bit simpler. An important difference is that it returns null if the field does not exist or is empty, allowing you to just show nothing or use ...Picture(...) ?? someFallback; IResponsiveImage Img(string name, NoParamOrder noParamOrder, object settings, object factor, object width, string imgAlt, string imgAltFallback, string imgClass, object imgAttributes, object toolbar, object recipe) Parameters name string Name of a field noParamOrder NoParamOrder see Convention: Named Parameters settings object The name of a settings configuration, like \"Content\", \"Screen\", \"Square\", etc. A standardized Image-Settings object like Settings.Child(\"Images.Content\") - see https://go.2sxc.org/settings A dynamic object containing settings properties (this can also be a merged custom + standard settings) A strictly typed IResizeSettings object containing all settings created using ResizeSettings factor object An optional multiplier, usually used to create urls which resize to a part of the default content-size. Eg. 0.5. width object An optional, fixed width of the image imgAlt string Optional alt attribute on the created img tag for SEO etc. If supplied, it takes precedence to the alt-description in the image metadata which the editor added themselves. If you want to provide a fallback value (in case the metadata has no alt), use imgAltFallback imgAltFallback string Optional alt attribute which is only used if the imgAlt or the alt-text in the metadata are empty. imgClass string Optional class attribute on the created img tag imgAttributes object Optional additional attributes - as anonymous object eg new { style = \"padding: 10px\" } or Dictionary (new 16.07) toolbar object Provide a custom toolbar or false to not show a toolbar recipe object Optional recipe = instructions how to create the various variants of this link. Can be any one of these: string containing variants Rule object TODO: DOCS not quite ready Returns IResponsiveImage A IResponsivePicture object which can be rendered directly. See Responsive Images API in .net If the field does not exist, it will return null If the field exists, but is empty, it will return null Remarks Added to ITypedItem in v17.04 (previously only Picture was available) Parent(NoParamOrder, bool?, string, string) Get either the current parent or the first parent which would be found on .Parents(...). ITypedItem Parent(NoParamOrder noParamOrder = default, bool? current = null, string type = null, string field = null) Parameters noParamOrder NoParamOrder see Convention: Named Parameters current bool? if set to true, will get the Item which created the current item (the parent) which called .Child(...) or .Children(...) type string Optional type filter - would only return items of this type. field string Optional field filter - would only return items that point to the current item in a specific field name. Returns ITypedItem either the current parent or the first parent returned by the same .Parents(...) call. Parent(NoParamOrder, bool?, string, string) Get either the current parent or the first parent which would be found on .Parents(...) as strongly typed. T Parent(NoParamOrder protector = default, bool? current = null, string type = null, string field = null) where T : class, ITypedItemWrapper16, ITypedItem, new() Parameters protector NoParamOrder see Convention: Named Parameters current bool? if set to true, will get the Item which created the current item (the parent) which called .Child(...) or .Children(...) type string Optional type filter - would only return items of this type. field string Optional field filter - would only return items that point to the current item in a specific field name. Returns T either the current parent or the first parent returned by the same .Parents(...) call. Type Parameters T Remarks New v17.06 Parents(NoParamOrder, string, string) A typed list of entities which point to this item. Important for LINQ style querying or just working with various lists. Note that for getting child items of this item you can just use the properties, like content.Authors. Please check the tutorials on 2sxc.org/dnn-tutorials/ for more info. IEnumerable Parents(NoParamOrder noParamOrder = default, string type = null, string field = null) Parameters noParamOrder NoParamOrder see Convention: Named Parameters type string Optional type filter - would only return items of this type. field string Optional field filter - would only return items that point to the current item in a specific field name. Returns IEnumerable A list of all items pointing here (filtered), converted to DynamicEntity for convenience. Remarks Note that the parameter-order is reversed to the Children() Parents(NoParamOrder, string, string) A typed list of entities which point to this item. Important for LINQ style querying or just working with various lists. Note that for getting child items of this item you can just use the properties, like content.Authors. Please check the tutorials on 2sxc.org/dnn-tutorials/ for more info. IEnumerable Parents(NoParamOrder protector = default, string type = null, string field = null) where T : class, ITypedItemWrapper16, ITypedItem, new() Parameters protector NoParamOrder see Convention: Named Parameters type string Optional type filter - would only return items of this type. If not specified (null) will use the name of T. field string Optional field filter - would only return items that point to the current item in a specific field name. Returns IEnumerable A list of all items pointing here (filtered), converted to DynamicEntity for convenience. Type Parameters T Remarks Note that the parameter-order is reversed to the Children() Picture(string, NoParamOrder, object, object, object, string, string, string, object, string, object, object, object) Get a Responsive Picture object which you can then either just show, or use to construct a more customized output as you need it. The resulting object can just be added to the html, like @pic or you can work with sub-properties as specified in the IResponsivePicture. Important: This call only allows you to set the most common parameters factor and width. For other parameters like height, aspectRatio, quality etc. create typed Settings Settings(object, NoParamOrder, object, object, object, object, string, string, string, object, string, object) and pass them in. Note This is the similar as using the Picture(object, object, NoParamOrder, object, object, string, string, string, object, string, object, object, object) just a bit simpler. An important difference is that it returns null if the field does not exist or is empty, allowing you to just show nothing or use ...Picture(...) ?? someFallback; IResponsivePicture Picture(string name, NoParamOrder noParamOrder = default, object settings = null, object factor = null, object width = null, string imgAlt = null, string imgAltFallback = null, string imgClass = null, object imgAttributes = null, string pictureClass = null, object pictureAttributes = null, object toolbar = null, object recipe = null) Parameters name string Name of a field noParamOrder NoParamOrder see Convention: Named Parameters settings object The name of a settings configuration, like \"Content\", \"Screen\", \"Square\", etc. A standardized Image-Settings object like Settings.Child(\"Images.Content\") - see https://go.2sxc.org/settings A dynamic object containing settings properties (this can also be a merged custom + standard settings) A strictly typed IResizeSettings object containing all settings created using ResizeSettings factor object An optional multiplier, usually used to create urls which resize to a part of the default content-size. Eg. 0.5. width object An optional, fixed width of the image imgAlt string Optional alt attribute on the created img tag for SEO etc. If supplied, it takes precedence to the alt-description in the image metadata which the editor added themselves. If you want to provide a fallback value (in case the metadata has no alt), use imgAltFallback imgAltFallback string Optional alt attribute which is only used if the imgAlt or the alt-text in the metadata are empty. imgClass string Optional class attribute on the created img tag imgAttributes object Optional additional attributes - as anonymous object eg new { style = \"padding: 10px\" } or Dictionary (new 16.07) pictureClass string Optional class attribute on the created picture tag pictureAttributes object Optional additional attributes - as anonymous object eg new { style = \"padding: 10px\" } or Dictionary (new 16.07) toolbar object Provide a custom toolbar or false to not show a toolbar recipe object Optional recipe = instructions how to create the various variants of this link. Can be any one of these: string containing variants Rule object TODO: DOCS not quite ready Returns IResponsivePicture A IResponsivePicture object which can be rendered directly. See Responsive Images API in .net If the field does not exist, it will return null If the field exists, but is empty, it will return null Remarks Added to ITypedItem in v16.03 imgAttributes, picClass and picAttributes added in 16.07" + "keywords": "Interface ITypedItem Namespace ToSic.Sxc.Data Assembly ToSic.Sxc.dll A typed object to access data. Previously Razor code always used dynamic IDynamicEntity objects. This had some disadvantages when working with LINQ or advanced toolbars. [PublicApi] [JsonConverter(typeof(DynamicJsonConverter))] public interface ITypedItem : ITyped, IEquatable Inherited Members ITyped.Bool(string, NoParamOrder, bool, bool?) ITyped.DateTime(string, NoParamOrder, DateTime, bool?) ITyped.String(string, NoParamOrder, string, bool?, object) ITyped.Int(string, NoParamOrder, int, bool?) ITyped.Long(string, NoParamOrder, long, bool?) ITyped.Float(string, NoParamOrder, float, bool?) ITyped.Decimal(string, NoParamOrder, decimal, bool?) ITyped.Double(string, NoParamOrder, double, bool?) ITyped.Url(string, NoParamOrder, string, bool?) ITyped.Attribute(string, NoParamOrder, string, bool?) ITyped.ContainsKey(string) ITyped.IsEmpty(string, NoParamOrder) ITyped.IsNotEmpty(string, NoParamOrder) ITyped.Keys(NoParamOrder, IEnumerable) ITyped.Get(string, NoParamOrder, bool?) ITyped.Get(string, NoParamOrder, TValue, bool?) IEquatable.Equals(ITypedItem) Remarks Introduced in 2sxc 16.01 Properties Dyn A dynamic accessor for properties, to quickly get values when you don't care about type safety. This is often (but not always) a IDynamicEntity. Example: Dyn.FirstName might just work - and return the first name or null if not found. dynamic Dyn { get; } Property Value dynamic Guid The guid of the underlying entity. Guid Guid { get; } Property Value Guid Remarks If the entity doesn't exist, it will return an empty guid Id The ID of the underlying entity. Use it for edit-functionality or just to have a unique number for this item. int Id { get; } Property Value int Remarks If the entity doesn't exist, it will return 0 IsDemoItem Many templates show demo data. If the template code must know if it's the demo item or real data, use .IsDemoItem. bool IsDemoItem { get; } Property Value bool True if this is the item configured in the view-settings, false if not. IsPublished True if this item version is published. This means that the item can exist as published, or published-with-draft, showing the published version. Note that by default, end-users only see the published version and don't see any draft version. bool IsPublished { get; } Property Value bool Remarks New in v17, see also Publishing Metadata Metadata of the current item, with special features. IMetadata Metadata { get; } Property Value IMetadata Remarks Added in 16.02 Presentation The presentation item or null if it doesn't exist. ITypedItem Presentation { get; } Property Value ITypedItem Publishing IPublishing Publishing { get; } Property Value IPublishing Title The title of this item. This is always available no matter what the underlying field for the title is. string Title { get; } Property Value string The title of the underlying entity. In rare cases where no title-field is known, it can be null. It can also be null if there is no underlying entity. Remarks This returns a string which is usually what's expected. In previous versions (before v15) 2sxc it returned an object. Type The Content-Type of the current entity. IContentType Type { get; } Property Value IContentType Methods Child(string, NoParamOrder, bool?) A single item from a field. ITypedItem Child(string name, NoParamOrder noParamOrder = default, bool? required = null) Parameters name string Name of the field noParamOrder NoParamOrder see Convention: Named Parameters required bool? throw error if name doesn't exist, see Convention: Property Required Name Checks Returns ITypedItem The ITypedItem. If the field doesn't exist or is empty, will return null. Child(string, NoParamOrder, bool?) Get a child and return with specified custom type. T Child(string name = null, NoParamOrder protector = default, bool? required = null) where T : class, ITypedItemWrapper16, ITypedItem, new() Parameters name string Name of the field protector NoParamOrder see Convention: Named Parameters required bool? throw error if name doesn't exist, see Convention: Property Required Name Checks Returns T Type Parameters T Remarks New v17.05 Children(string, NoParamOrder, string, bool?) A typed list of sub-items. Important for LINQ style querying or just working with various lists. Note that for getting child items of this item you can just use the properties, like content.Authors. But using Children(\"Authors\", type: typeName) gives you the ability to restrict to a type. Please check the tutorials on 2sxc.org/dnn-tutorials/ for more info. IEnumerable Children(string field = null, NoParamOrder noParamOrder = default, string type = null, bool? required = null) Parameters field string Optional field filter - would only return items that point to the current item in a specific field name. noParamOrder NoParamOrder see Convention: Named Parameters type string Optional type filter - would only return items of this type. required bool? throw error if name doesn't exist, see Convention: Property Required Name Checks Returns IEnumerable A list of all items pointing here (filtered), converted to DynamicEntity for convenience. Remarks Note that the parameter-order is reversed to the Parents() Children(string, NoParamOrder, string, bool?) A strongly typed list of sub-items. Important for LINQ style querying or just working with various lists. Note that for getting child items of this item you can just use the properties, like content.Authors. But using Children(\"Authors\", type: typeName) gives you the ability to restrict to a type. Please check the tutorials on 2sxc.org/dnn-tutorials/ for more info. IEnumerable Children(string field = null, NoParamOrder protector = default, string type = null, bool? required = null) where T : class, ITypedItemWrapper16, ITypedItem, new() Parameters field string Name of the field protector NoParamOrder see Convention: Named Parameters type string Optional type filter - would only return items of this type. required bool? throw error if name doesn't exist, see Convention: Property Required Name Checks Returns IEnumerable Type Parameters T Remarks New v17.05 Field(string, NoParamOrder, bool?) Get a special info-object describing a specific field in this item. This is a rich object used by other operations which need a lot of context about the item and the field. IField Field(string name, NoParamOrder noParamOrder = default, bool? required = null) Parameters name string Name of the property noParamOrder NoParamOrder see Convention: Named Parameters required bool? throw error if name doesn't exist, see Convention: Property Required Name Checks Returns IField File(string, NoParamOrder, bool?) Get the file of the current field. There are a few scenarios: If it's a file/hyperlink field pointing to a file such as file:27 it will retrieve the file itself. If it's a file/hyperlink field pointing to a url such as http://xyz it will return null. If it's a library field, it will just take the first file, as there is no value referencing a specific field If it's any other field, will return null IFile File(string name, NoParamOrder noParamOrder = default, bool? required = null) Parameters name string property name noParamOrder NoParamOrder see Convention: Named Parameters required bool? throw error if name doesn't exist, see Convention: Property Required Name Checks Returns IFile Remarks Added in 16.02 Folder(string, NoParamOrder, bool?) Get the ADAM (Automatic Digital Asset Manager) for this field. This is a folder which contains all the files and possibly folders which are uploaded on exactly this field. IFolder Folder(string name, NoParamOrder noParamOrder = default, bool? required = null) Parameters name string property name noParamOrder NoParamOrder see Convention: Named Parameters required bool? throw error if name doesn't exist, see Convention: Property Required Name Checks Returns IFolder The Folder object Remarks Added in 16.02 Gps(string, NoParamOrder, bool?) Get the GPS coordinates of a GPS field as a typed object. GpsCoordinates Gps(string name, NoParamOrder protector = default, bool? required = null) Parameters name string Name of a field protector NoParamOrder see Convention: Named Parameters required bool? throw error if name doesn't exist, see Convention: Property Required Name Checks Returns GpsCoordinates Remarks New in v17.03 Html(string, NoParamOrder, object, bool?, object, bool?, bool, Func, ITweakInput>) Show a field in the expected / best possible way. As of now it's meant for WYSIWYG fields with Very-Rich Text. See DynamicEntity / TypedItem .Html(...) Method new v16.01 IHtmlTag Html(string name, NoParamOrder noParamOrder = default, object container = null, bool? toolbar = null, object imageSettings = null, bool? required = null, bool debug = false, Func, ITweakInput> tweak = null) Parameters name string the field name noParamOrder NoParamOrder see Convention: Named Parameters container object A wrapper tag for the result. It's either a RazorBlade tag such as Kit.HtmlTag.Div(), a string such as span or an empty string `` to indicate no container. If not set it will default to to a div-tag. See docs toolbar bool? Override default toolbar behavior on this field. See docs imageSettings object Settings for resizing. Default is Wysiwyg but it can also be Content or a settings object. required bool? throw error if name doesn't exist, see Convention: Property Required Name Checks debug bool Activate debug visualization to better see alignments and such. tweak Func, ITweakInput> tweak behavior - ATM modify the input before it's processed new in v17 Returns IHtmlTag Remarks Added in 2sxc 16.01 Added tweak in v17 Only works on Razor files inheriting from Hybrid14 or newer Img(string, NoParamOrder, object, object, object, string, string, string, object, object, object) Get a Responsive Picture object which you can then either just show, or use to construct a more customized output as you need it. The resulting object can just be added to the html, like @pic or you can work with sub-properties as specified in the IResponsivePicture. Important: This call only allows you to set the most common parameters factor and width. For other parameters like height, aspectRatio, quality etc. create typed Settings Settings(object, NoParamOrder, object, object, object, object, string, string, string, object, string, object) and pass them in. Note This is the similar as using the Picture(object, object, NoParamOrder, object, object, string, string, string, object, string, object, object, object) just a bit simpler. An important difference is that it returns null if the field does not exist or is empty, allowing you to just show nothing or use ...Picture(...) ?? someFallback; IResponsiveImage Img(string name, NoParamOrder noParamOrder = default, object settings = null, object factor = null, object width = null, string imgAlt = null, string imgAltFallback = null, string imgClass = null, object imgAttributes = null, object toolbar = null, object recipe = null) Parameters name string Name of a field noParamOrder NoParamOrder see Convention: Named Parameters settings object The name of a settings configuration, like \"Content\", \"Screen\", \"Square\", etc. A standardized Image-Settings object like Settings.Child(\"Images.Content\") - see https://go.2sxc.org/settings A dynamic object containing settings properties (this can also be a merged custom + standard settings) A strictly typed IResizeSettings object containing all settings created using ResizeSettings factor object An optional multiplier, usually used to create urls which resize to a part of the default content-size. Eg. 0.5. width object An optional, fixed width of the image imgAlt string Optional alt attribute on the created img tag for SEO etc. If supplied, it takes precedence to the alt-description in the image metadata which the editor added themselves. If you want to provide a fallback value (in case the metadata has no alt), use imgAltFallback imgAltFallback string Optional alt attribute which is only used if the imgAlt or the alt-text in the metadata are empty. imgClass string Optional class attribute on the created img tag imgAttributes object Optional additional attributes - as anonymous object eg new { style = \"padding: 10px\" } or Dictionary (new 16.07) toolbar object Provide a custom toolbar or false to not show a toolbar recipe object Optional recipe = instructions how to create the various variants of this link. Can be any one of these: string containing variants Rule object TODO: DOCS not quite ready Returns IResponsiveImage A IResponsivePicture object which can be rendered directly. See Responsive Images API in .net If the field does not exist, it will return null If the field exists, but is empty, it will return null Remarks Added to ITypedItem in v17.04 (previously only Picture was available) Parent(NoParamOrder, bool?, string, string) Get either the current parent or the first parent which would be found on .Parents(...). ITypedItem Parent(NoParamOrder noParamOrder = default, bool? current = null, string type = null, string field = null) Parameters noParamOrder NoParamOrder see Convention: Named Parameters current bool? if set to true, will get the Item which created the current item (the parent) which called .Child(...) or .Children(...) type string Optional type filter - would only return items of this type. field string Optional field filter - would only return items that point to the current item in a specific field name. Returns ITypedItem either the current parent or the first parent returned by the same .Parents(...) call. Parent(NoParamOrder, bool?, string, string) Get either the current parent or the first parent which would be found on .Parents(...) as strongly typed. T Parent(NoParamOrder protector = default, bool? current = null, string type = null, string field = null) where T : class, ITypedItemWrapper16, ITypedItem, new() Parameters protector NoParamOrder see Convention: Named Parameters current bool? if set to true, will get the Item which created the current item (the parent) which called .Child(...) or .Children(...) type string Optional type filter - would only return items of this type. field string Optional field filter - would only return items that point to the current item in a specific field name. Returns T either the current parent or the first parent returned by the same .Parents(...) call. Type Parameters T Remarks New v17.06 Parents(NoParamOrder, string, string) A typed list of entities which point to this item. Important for LINQ style querying or just working with various lists. Note that for getting child items of this item you can just use the properties, like content.Authors. Please check the tutorials on 2sxc.org/dnn-tutorials/ for more info. IEnumerable Parents(NoParamOrder noParamOrder = default, string type = null, string field = null) Parameters noParamOrder NoParamOrder see Convention: Named Parameters type string Optional type filter - would only return items of this type. field string Optional field filter - would only return items that point to the current item in a specific field name. Returns IEnumerable A list of all items pointing here (filtered), converted to DynamicEntity for convenience. Remarks Note that the parameter-order is reversed to the Children() Parents(NoParamOrder, string, string) A typed list of entities which point to this item. Important for LINQ style querying or just working with various lists. Note that for getting child items of this item you can just use the properties, like content.Authors. Please check the tutorials on 2sxc.org/dnn-tutorials/ for more info. IEnumerable Parents(NoParamOrder protector = default, string type = null, string field = null) where T : class, ITypedItemWrapper16, ITypedItem, new() Parameters protector NoParamOrder see Convention: Named Parameters type string Optional type filter - would only return items of this type. If not specified (null) will use the name of T. field string Optional field filter - would only return items that point to the current item in a specific field name. Returns IEnumerable A list of all items pointing here (filtered), converted to DynamicEntity for convenience. Type Parameters T Remarks Note that the parameter-order is reversed to the Children() Picture(string, NoParamOrder, object, object, object, string, string, string, object, string, object, object, object) Get a Responsive Picture object which you can then either just show, or use to construct a more customized output as you need it. The resulting object can just be added to the html, like @pic or you can work with sub-properties as specified in the IResponsivePicture. Important: This call only allows you to set the most common parameters factor and width. For other parameters like height, aspectRatio, quality etc. create typed Settings Settings(object, NoParamOrder, object, object, object, object, string, string, string, object, string, object) and pass them in. Note This is the similar as using the Picture(object, object, NoParamOrder, object, object, string, string, string, object, string, object, object, object) just a bit simpler. An important difference is that it returns null if the field does not exist or is empty, allowing you to just show nothing or use ...Picture(...) ?? someFallback; IResponsivePicture Picture(string name, NoParamOrder noParamOrder = default, object settings = null, object factor = null, object width = null, string imgAlt = null, string imgAltFallback = null, string imgClass = null, object imgAttributes = null, string pictureClass = null, object pictureAttributes = null, object toolbar = null, object recipe = null) Parameters name string Name of a field noParamOrder NoParamOrder see Convention: Named Parameters settings object The name of a settings configuration, like \"Content\", \"Screen\", \"Square\", etc. A standardized Image-Settings object like Settings.Child(\"Images.Content\") - see https://go.2sxc.org/settings A dynamic object containing settings properties (this can also be a merged custom + standard settings) A strictly typed IResizeSettings object containing all settings created using ResizeSettings factor object An optional multiplier, usually used to create urls which resize to a part of the default content-size. Eg. 0.5. width object An optional, fixed width of the image imgAlt string Optional alt attribute on the created img tag for SEO etc. If supplied, it takes precedence to the alt-description in the image metadata which the editor added themselves. If you want to provide a fallback value (in case the metadata has no alt), use imgAltFallback imgAltFallback string Optional alt attribute which is only used if the imgAlt or the alt-text in the metadata are empty. imgClass string Optional class attribute on the created img tag imgAttributes object Optional additional attributes - as anonymous object eg new { style = \"padding: 10px\" } or Dictionary (new 16.07) pictureClass string Optional class attribute on the created picture tag pictureAttributes object Optional additional attributes - as anonymous object eg new { style = \"padding: 10px\" } or Dictionary (new 16.07) toolbar object Provide a custom toolbar or false to not show a toolbar recipe object Optional recipe = instructions how to create the various variants of this link. Can be any one of these: string containing variants Rule object TODO: DOCS not quite ready Returns IResponsivePicture A IResponsivePicture object which can be rendered directly. See Responsive Images API in .net If the field does not exist, it will return null If the field exists, but is empty, it will return null Remarks Added to ITypedItem in v16.03 imgAttributes, picClass and picAttributes added in 16.07" }, "api/dot-net/ToSic.Sxc.Data.ITypedStack.html": { "href": "api/dot-net/ToSic.Sxc.Data.ITypedStack.html", "title": "Interface ITypedStack | 2sxc 17 for Dnn and Oqtane", - "keywords": "Interface ITypedStack Namespace ToSic.Sxc.Data Assembly ToSic.Sxc.dll [PublicApi] public interface ITypedStack : ITyped, ICanDebug Inherited Members ITyped.Bool(string, NoParamOrder, bool, bool?) ITyped.DateTime(string, NoParamOrder, DateTime, bool?) ITyped.String(string, NoParamOrder, string, bool?, object) ITyped.Int(string, NoParamOrder, int, bool?) ITyped.Long(string, NoParamOrder, long, bool?) ITyped.Float(string, NoParamOrder, float, bool?) ITyped.Decimal(string, NoParamOrder, decimal, bool?) ITyped.Double(string, NoParamOrder, double, bool?) ITyped.Url(string, NoParamOrder, string, bool?) ITyped.Attribute(string, NoParamOrder, string, bool?) ITyped.ContainsKey(string) ITyped.IsEmpty(string, NoParamOrder) ITyped.IsNotEmpty(string, NoParamOrder) ITyped.Keys(NoParamOrder, IEnumerable) ITyped.Get(string, NoParamOrder, bool?) ITyped.Get(string, NoParamOrder, TValue, bool?) ICanDebug.Debug Methods Child(string, NoParamOrder, bool?) ITypedItem Child(string name, NoParamOrder noParamOrder = default, bool? required = null) Parameters name string noParamOrder NoParamOrder required bool? Returns ITypedItem Children(string, NoParamOrder, string, bool?) A typed list of sub-items. Important for LINQ style querying or just working with various lists. Note that for getting child items of this item you can just use the properties, like content.Authors. But using Children(\"Authors\", type: typeName) gives you the ability to restrict to a type. Please check the tutorials on 2sxc.org/dnn-tutorials/ for more info. IEnumerable Children(string field = null, NoParamOrder noParamOrder = default, string type = null, bool? required = null) Parameters field string Optional field filter - would only return items that point to the current item in a specific field name. noParamOrder NoParamOrder see Convention: Named Parameters type string Optional type filter - would only return items of this type. required bool? throw error if name doesn't exist, see Convention: Property Required Name Checks Returns IEnumerable A list of all items pointing here (filtered), converted to DynamicEntity for convenience. Remarks Note that the parameter-order is reversed to the Parents()" + "keywords": "Interface ITypedStack Namespace ToSic.Sxc.Data Assembly ToSic.Sxc.dll The stack as typed object. [PublicApi] public interface ITypedStack : ITypedItem, ITyped, IEquatable, ICanDebug Inherited Members ITypedItem.Dyn ITypedItem.Presentation ITypedItem.Metadata ITypedItem.Field(string, NoParamOrder, bool?) ITypedItem.Folder(string, NoParamOrder, bool?) ITypedItem.File(string, NoParamOrder, bool?) ITypedItem.Child(string, NoParamOrder, bool?) ITypedItem.Children(string, NoParamOrder, string, bool?) ITypedItem.Parent(NoParamOrder, bool?, string, string) ITypedItem.Parents(NoParamOrder, string, string) ITypedItem.Child(string, NoParamOrder, bool?) ITypedItem.Children(string, NoParamOrder, string, bool?) ITypedItem.Parent(NoParamOrder, bool?, string, string) ITypedItem.Parents(NoParamOrder, string, string) ITypedItem.IsPublished ITypedItem.Publishing ITypedItem.IsDemoItem ITypedItem.Html(string, NoParamOrder, object, bool?, object, bool?, bool, Func, ITweakInput>) ITypedItem.Picture(string, NoParamOrder, object, object, object, string, string, string, object, string, object, object, object) ITypedItem.Img(string, NoParamOrder, object, object, object, string, string, string, object, object, object) ITypedItem.Gps(string, NoParamOrder, bool?) ITypedItem.Id ITypedItem.Guid ITypedItem.Title ITypedItem.Type ITyped.Bool(string, NoParamOrder, bool, bool?) ITyped.DateTime(string, NoParamOrder, DateTime, bool?) ITyped.String(string, NoParamOrder, string, bool?, object) ITyped.Int(string, NoParamOrder, int, bool?) ITyped.Long(string, NoParamOrder, long, bool?) ITyped.Float(string, NoParamOrder, float, bool?) ITyped.Decimal(string, NoParamOrder, decimal, bool?) ITyped.Double(string, NoParamOrder, double, bool?) ITyped.Url(string, NoParamOrder, string, bool?) ITyped.Attribute(string, NoParamOrder, string, bool?) ITyped.ContainsKey(string) ITyped.IsEmpty(string, NoParamOrder) ITyped.IsNotEmpty(string, NoParamOrder) ITyped.Keys(NoParamOrder, IEnumerable) ITyped.Get(string, NoParamOrder, bool?) ITyped.Get(string, NoParamOrder, TValue, bool?) IEquatable.Equals(ITypedItem) ICanDebug.Debug Remarks Enhanced in v17.07 to fully support ITypedItem, before it only supported ITyped." }, "api/dot-net/ToSic.Sxc.Data.html": { "href": "api/dot-net/ToSic.Sxc.Data.html", "title": "Namespace ToSic.Sxc.Data | 2sxc 17 for Dnn and Oqtane", - "keywords": "Namespace ToSic.Sxc.Data The dynamic data system used in 2sxc. It's primary purpose is to ensure that you can easily use dynamic objects to write templates, tokens and more. we have two different topics covered: Dynamic Entities to simplify code using IEntity objects - IDynamicEntity and Dynamic Jackets to simplify code using JSON - ToSic.Sxc.Data.DynamicJackets and ToSic.Sxc.Data.DynamicJacketLists Interfaces IDynamicEntity This is a wrapper for IEntity objects. It provides nicer access to underlying properties and automatically handles things like multi-language etc. The underlying IEntity IEntity is in the Entity property. Normally you will use it without caring about these internals. Please check @HowTo.DynamicCode.DynamicEntity IDynamicStack This is a dynamic object which contains multiple dynamic objects (Sources). It will try to find a value inside each source in the order the Sources are managed. IField This describes a field-property of an item/entity. It's used for APIs which can need to know more about the field holding an item, like: The field name and parent reference The values in raw and converted Any metadata of the field IMetadata Metadata on Dynamic Objects - like IDynamicEntity or IAsset (files/folders). Behaves like a normal DynamicEntity, but has additional commands to detect if specific Metadata exists. IPublishing Publishing Information for ITypedItems. ISecureData This object contains decrypted data (if it was encrypted originally) and tells you if the data was encrypted, signed etc. It's still very basic, and will grow in functionality to assist in handling secure / encrypted / signed data. ITyped This describes objects which usually wrap other objects to provide strictly typed access to properties. have typed Methods to read properties like .String(propName). It's usually the result of a AsTyped(something) or AsItem(...) command. It's meant to help Razor etc. access unknown or dynamic objects in a typed way. ITypedItem A typed object to access data. Previously Razor code always used dynamic IDynamicEntity objects. This had some disadvantages when working with LINQ or advanced toolbars. ITypedStack" + "keywords": "Namespace ToSic.Sxc.Data The dynamic data system used in 2sxc. It's primary purpose is to ensure that you can easily use dynamic objects to write templates, tokens and more. we have two different topics covered: Dynamic Entities to simplify code using IEntity objects - IDynamicEntity and Dynamic Jackets to simplify code using JSON - ToSic.Sxc.Data.DynamicJackets and ToSic.Sxc.Data.DynamicJacketLists Interfaces IDynamicEntity This is a wrapper for IEntity objects. It provides nicer access to underlying properties and automatically handles things like multi-language etc. The underlying IEntity IEntity is in the Entity property. Normally you will use it without caring about these internals. Please check @HowTo.DynamicCode.DynamicEntity IDynamicStack This is a dynamic object which contains multiple dynamic objects (Sources). It will try to find a value inside each source in the order the Sources are managed. IField This describes a field-property of an item/entity. It's used for APIs which can need to know more about the field holding an item, like: The field name and parent reference The values in raw and converted Any metadata of the field IMetadata Metadata on Dynamic Objects - like IDynamicEntity or IAsset (files/folders). Behaves like a normal DynamicEntity, but has additional commands to detect if specific Metadata exists. IPublishing Publishing Information for ITypedItems. ISecureData This object contains decrypted data (if it was encrypted originally) and tells you if the data was encrypted, signed etc. It's still very basic, and will grow in functionality to assist in handling secure / encrypted / signed data. ITyped This describes objects which usually wrap other objects to provide strictly typed access to properties. have typed Methods to read properties like .String(propName). It's usually the result of a AsTyped(something) or AsItem(...) command. It's meant to help Razor etc. access unknown or dynamic objects in a typed way. ITypedItem A typed object to access data. Previously Razor code always used dynamic IDynamicEntity objects. This had some disadvantages when working with LINQ or advanced toolbars. ITypedStack The stack as typed object." }, "api/dot-net/ToSic.Sxc.DataSources.CmsBlock.html": { "href": "api/dot-net/ToSic.Sxc.DataSources.CmsBlock.html", @@ -2332,7 +2332,7 @@ "api/dot-net/ToSic.Sxc.Services.ILinkService.html": { "href": "api/dot-net/ToSic.Sxc.Services.ILinkService.html", "title": "Interface ILinkService | 2sxc 17 for Dnn and Oqtane", - "keywords": "Interface ILinkService Namespace ToSic.Sxc.Services Assembly ToSic.Sxc.dll Helpers to create links to Pages APIs Images As well as create base-tag links (important for SPAs) You will never create this yourself, as get this automatically in Razor or WebAPIs on an object called Link. [PublicApi] public interface ILinkService : ICanDebug Inherited Members ICanDebug.Debug Remarks History Created ca. v2 as ToSic.Sxc.Web.ILinkHelper Moved to this new Services.ILinkService in v13.05. The previous name will continue to work, but newer features will be missing on that interface. Methods Base() A base url for the current page, for use in html-base tags string Base() Returns string Image(string, object, object, NoParamOrder, IField, object, object, object, string, string, string, object, string, object) Generate an Image-Resizing link base on presets or custom parameters. It will also ensure that the final url is safe, so it will encode umlauts, spaces etc. Note that you can basically just use presets, or set every parameter manually. All params are optional. Some combinations are not valid - like setting a factor and a width doesn't make sense and will throw an error Most parameters if set to 0 will cause a reset so that this aspect is not in the URL string Image(string url = null, object settings = null, object factor = null, NoParamOrder noParamOrder = default, IField field = null, object width = null, object height = null, object quality = null, string resizeMode = null, string scaleMode = null, string format = null, object aspectRatio = null, string type = null, object parameters = null) Parameters url string The image url. Use an empty string if you want to just get the params for re-use. settings object A standardized Image-Settings object like Settings.Images.Content - see https://go.2sxc.org/settings Or a dynamic object containing settings properties (this can also be a merged custom + standard settings) Or a specially prepared IResizeSettings object containing all settings. If this is provided, only factor will still be respected, all other settings like width on this command will be ignored. factor object A multiplier, usually used to create urls which resize to a part of the default content-size. Eg. 0.5. noParamOrder NoParamOrder see Convention: Named Parameters field IField WIP v13.04 - not final yet width object Optional width parameter. Usually takes the default from the settings. height object Optional height parameter. Usually takes the default from the settings. quality object Optional quality parameter. Usually takes the default from the settings. resizeMode string Optional resize-mode, like crop or max. Usually takes the default from the settings. scaleMode string Optional scale-mode to allow up-scaling images like up or both. Usually takes the default from the settings. format string Optional file format like jpg or png aspectRatio object Aspect Ratio width/height, only relevant if a width is supplied. Can't be used together with height. Usually takes default from the settings or is ignored. type string Optional type changes how the link is generated. Possible values are: null / not specified / empty = return link as is generated \"full\" return link with protocol and domain. If that was missing before, it will add current protocol/domain if possible, but not on relative ./ or ../ links \"//\" return link with //domain. If that was missing before, will add current domain if possible, but not on relative ./ or ../ links parameters object the parameters either as id=47&name=daniel (Dnn also supports /id/47/name/daniel) in 2sxc 12.05+ it can also be an IParameters Returns string Remarks Usually a factor is applied to create a link which is possibly 50% of the content-width or similar. In these cases the height is not applied but the aspectRatio is used, which usually comes from settings if any were provided. History New in 2sxc 12.03 type added ca. v12.08 Option to use IResizeSettings added in v13.03 factor originally didn't influence width/height if provided here, updated it v13.03 to influence that as well field being added in 13.04, not ready yet To(NoParamOrder, int?, string, object, string, string) returns a link to the current page with parameters resolved in a way that DNN wants it string To(NoParamOrder noParamOrder = default, int? pageId = null, string api = null, object parameters = null, string type = null, string language = null) Parameters noParamOrder NoParamOrder see Convention: Named Parameters pageId int? optional page ID (TabId) - if not supplied, will use current page api string optional api url \"api/name/method?id=something\" parameters object the parameters either as id=47&name=daniel (Dnn also supports /id/47/name/daniel) in 2sxc 12.05+ it can also be an IParameters type string Optional type changes how the link is generated. Possible values are: null / not specified / empty = return link as is generated \"full\" return link with protocol and domain. If that was missing before, it will add current protocol/domain if possible, but not on relative ./ or ../ links \"//\" return link with //domain. If that was missing before, will add current domain if possible, but not on relative ./ or ../ links language string If not set, null or empty \"\" will use the specified pageId (pageIds can be language specific); api would always be the current language If set to \"current\" will adjust pageId to use the language of the current language. API will be as before, as it was already current future (not implemented yet) \"primary\" would link to primary language future (not implemented yet) \"en\" or \"en-us\" would link to that specific language (page and API) Returns string Remarks History v12 added the api parameter for liking APIs of the current app In v12.05 the type of parameters was changed from string to object, to allow IParameters as well In v13.02 introduced language with \"current\"" + "keywords": "Interface ILinkService Namespace ToSic.Sxc.Services Assembly ToSic.Sxc.dll Helpers to create links to Pages APIs Images As well as create base-tag links (important for SPAs) You will never create this yourself, as get this automatically in Razor or WebAPIs on an object called Link. [PublicApi] public interface ILinkService : ICanDebug Inherited Members ICanDebug.Debug Remarks History Created ca. v2 as ToSic.Sxc.Web.ILinkHelper Moved to this new Services.ILinkService in v13.05. The previous name will continue to work, but newer features will be missing on that interface. Methods Base() A base url for the current page, for use in html-base tags string Base() Returns string Image(string, object, object, NoParamOrder, IField, object, object, object, string, string, string, object, string, object) Generate an Image-Resizing link base on presets or custom parameters. It will also ensure that the final url is safe, so it will encode umlauts, spaces etc. Note that you can basically just use presets, or set every parameter manually. All params are optional. Some combinations are not valid - like setting a factor and a width doesn't make sense and will throw an error Most parameters if set to 0 will cause a reset so that this aspect is not in the URL string Image(string url = null, object settings = null, object factor = null, NoParamOrder noParamOrder = default, IField field = null, object width = null, object height = null, object quality = null, string resizeMode = null, string scaleMode = null, string format = null, object aspectRatio = null, string type = null, object parameters = null) Parameters url string The image url. Use an empty string if you want to just get the params for re-use. settings object A settings name such as \"Content\", \"Lightbox\" etc. (new 17.06) A standardized Image-Settings object like Settings.Images.Content - see https://go.2sxc.org/settings Or a dynamic object containing settings properties (this can also be a merged custom + standard settings) Or a specially prepared IResizeSettings object containing all settings. If this is provided, only factor will still be respected, all other settings like width on this command will be ignored. factor object A multiplier, usually used to create urls which resize to a part of the default content-size. Eg. 0.5. noParamOrder NoParamOrder see Convention: Named Parameters field IField WIP v13.04 - not final yet width object Optional width parameter. Usually takes the default from the settings. height object Optional height parameter. Usually takes the default from the settings. quality object Optional quality parameter. Usually takes the default from the settings. resizeMode string Optional resize-mode, like crop or max. Usually takes the default from the settings. scaleMode string Optional scale-mode to allow up-scaling images like up or both. Usually takes the default from the settings. format string Optional file format like jpg or png aspectRatio object Aspect Ratio width/height, only relevant if a width is supplied. Can't be used together with height. Usually takes default from the settings or is ignored. type string Optional type changes how the link is generated. Possible values are: null / not specified / empty = return link as is generated \"full\" return link with protocol and domain. If that was missing before, it will add current protocol/domain if possible, but not on relative ./ or ../ links \"//\" return link with //domain. If that was missing before, will add current domain if possible, but not on relative ./ or ../ links parameters object the parameters either as id=47&name=daniel (Dnn also supports /id/47/name/daniel) in 2sxc 12.05+ it can also be an IParameters Returns string Remarks Usually a factor is applied to create a link which is possibly 50% of the content-width or similar. In these cases the height is not applied but the aspectRatio is used, which usually comes from settings if any were provided. History New in 2sxc 12.03 type added ca. v12.08 Option to use IResizeSettings added in v13.03 factor originally didn't influence width/height if provided here, updated it v13.03 to influence that as well field being added in 13.04, not ready yet To(NoParamOrder, int?, string, object, string, string) returns a link to the current page with parameters resolved in a way that DNN wants it string To(NoParamOrder noParamOrder = default, int? pageId = null, string api = null, object parameters = null, string type = null, string language = null) Parameters noParamOrder NoParamOrder see Convention: Named Parameters pageId int? optional page ID (TabId) - if not supplied, will use current page api string optional api url \"api/name/method?id=something\" parameters object the parameters either as id=47&name=daniel (Dnn also supports /id/47/name/daniel) in 2sxc 12.05+ it can also be an IParameters type string Optional type changes how the link is generated. Possible values are: null / not specified / empty = return link as is generated \"full\" return link with protocol and domain. If that was missing before, it will add current protocol/domain if possible, but not on relative ./ or ../ links \"//\" return link with //domain. If that was missing before, will add current domain if possible, but not on relative ./ or ../ links language string If not set, null or empty \"\" will use the specified pageId (pageIds can be language specific); api would always be the current language If set to \"current\" will adjust pageId to use the language of the current language. API will be as before, as it was already current future (not implemented yet) \"primary\" would link to primary language future (not implemented yet) \"en\" or \"en-us\" would link to that specific language (page and API) Returns string Remarks History v12 added the api parameter for liking APIs of the current app In v12.05 the type of parameters was changed from string to object, to allow IParameters as well In v13.02 introduced language with \"current\"" }, "api/dot-net/ToSic.Sxc.Services.IMailService.html": { "href": "api/dot-net/ToSic.Sxc.Services.IMailService.html", @@ -3132,7 +3132,7 @@ "basics/data/fields/custom-gps.html": { "href": "basics/data/fields/custom-gps.html", "title": "Field Input-Type custom-gps | 2sxc 17 for Dnn and Oqtane", - "keywords": "Field Input-Type custom-gps Use this field type for selecting positions on a map, storing custom JSON data. Features Auto-find the location based on address data already added to the form Pin can be moved manually Configure Custom-Gps Configure which fields are to be used to find the coordinates History Introduced in 2sxc 2.0" + "keywords": "Field Input-Type custom-gps Use this field type for selecting positions on a map, storing custom JSON data. Features Auto-find the location based on address data already added to the form Pin can be moved manually Configure Custom-Gps Configure which fields are to be used to find the coordinates History Introduced in 2sxc 2.0 - originally with a virtual field which placed the numbers into 2 number fields Modified behavior to use a JSON field instead ca. 2sxc 7 Improved Razor with ITypedItem to have a .Gps(...) method 2sxc 17" }, "basics/data/fields/custom.html": { "href": "basics/data/fields/custom.html", @@ -3747,7 +3747,7 @@ "index.html": { "href": "index.html", "title": "2sxc and EAV Docs | 2sxc 17 for Dnn and Oqtane", - "keywords": "2sxc and EAV Docs For version 17.06.03 LTS This is the technical documentation for EAV and 2sxc. If you're new to 2sxc, start with 2sxc.org. Convert Dnn ☢️ and Oqtane 🩸 into a CMS 2sxc is a CMS- and Meta-Plugin for Dnn/DotNetNuke and Oqtane. It makes content editing easier than other CMSs like Wordpress, while giving the designer full control. It's also a CMF like Drupal. And a very cool EAV data-management system. And a headless REST API. And a lot more. 2sxc is used to provide web-site-builder functionality. It has a simple Content mode where users just add images, designed text/image blocks, links etc. Then there's the sophisticated App mode, where user add standalone functional apps like blogs, galleries and more. Most apps are on github and can be downloaded from the app-catalog. Where to Start 2sxc is an easy to use dynamic content system for .net Platforms like Dnn. If you are just getting started, then this is probably not where you should be looking. Focus first on: The Basics which tells you about Architecture, Data Models and more Content on 2sxc.org like the learn section Apps on 2sxc Catalog which contains many ready-to-use apps like blogs and news, as well as tutorials The Dnn Tutorials on 2sxc.org 👉 With this knowledge, you can already create amazing stuff. 2sxc is very flexible and can be used for almost any kind of content-management needs or app development needs. Because of this, different documentations help you work with different things. Here's the overview: Many solutions and recommendations are found in the Blog on 2sxc.org Many demo, template and tutorial Apps are found in the App Catalog on 2sxc.org 2sxc / EAV Roadmap Pending Documentation Work Next to document Finish metadata documentation Create in the APIs (simplify APIs first) Create good sample of Page-Metadata App These topics are insufficiently documented... URL and REST API for changing data Future topics, lower priority 2. React and 2sxc (todo) etc. To Doc about Docs All kinds of customizations How Illustrations work (SVGs, CSS, JS etc.) Lightbox Possibly activation of additional languages How version switcher works How TOC customizations work icons in .net API HR splitters Other Cool Tools & Resources 2sxc Toolbar Builder by 10Pound Gorilla Gorillafied Blog Accu4.com - blog, experiments, tutorials" + "keywords": "2sxc and EAV Docs For version 17.07 LTS This is the technical documentation for EAV and 2sxc. If you're new to 2sxc, start with 2sxc.org. Convert Dnn ☢️ and Oqtane 🩸 into a CMS 2sxc is a CMS- and Meta-Plugin for Dnn/DotNetNuke and Oqtane. It makes content editing easier than other CMSs like Wordpress, while giving the designer full control. It's also a CMF like Drupal. And a very cool EAV data-management system. And a headless REST API. And a lot more. 2sxc is used to provide web-site-builder functionality. It has a simple Content mode where users just add images, designed text/image blocks, links etc. Then there's the sophisticated App mode, where user add standalone functional apps like blogs, galleries and more. Most apps are on github and can be downloaded from the app-catalog. Where to Start 2sxc is an easy to use dynamic content system for .net Platforms like Dnn. If you are just getting started, then this is probably not where you should be looking. Focus first on: The Basics which tells you about Architecture, Data Models and more Content on 2sxc.org like the learn section Apps on 2sxc Catalog which contains many ready-to-use apps like blogs and news, as well as tutorials The Dnn Tutorials on 2sxc.org 👉 With this knowledge, you can already create amazing stuff. 2sxc is very flexible and can be used for almost any kind of content-management needs or app development needs. Because of this, different documentations help you work with different things. Here's the overview: Many solutions and recommendations are found in the Blog on 2sxc.org Many demo, template and tutorial Apps are found in the App Catalog on 2sxc.org 2sxc / EAV Roadmap Pending Documentation Work Next to document Finish metadata documentation Create in the APIs (simplify APIs first) Create good sample of Page-Metadata App These topics are insufficiently documented... URL and REST API for changing data Future topics, lower priority 2. React and 2sxc (todo) etc. To Doc about Docs All kinds of customizations How Illustrations work (SVGs, CSS, JS etc.) Lightbox Possibly activation of additional languages How version switcher works How TOC customizations work icons in .net API HR splitters Other Cool Tools & Resources 2sxc Toolbar Builder by 10Pound Gorilla Gorillafied Blog Accu4.com - blog, experiments, tutorials" }, "js-code/2sxc-api/2sxc.cms.html": { "href": "js-code/2sxc-api/2sxc.cms.html", diff --git a/docs/xrefmap.yml b/docs/xrefmap.yml index 01680d5b7..b1aa91b52 100644 --- a/docs/xrefmap.yml +++ b/docs/xrefmap.yml @@ -4145,6 +4145,15 @@ references: isSpec: "True" fullName: Custom.Hybrid.ApiTyped.AsStack nameWithType: ApiTyped.AsStack +- uid: Custom.Hybrid.ApiTyped.AsStack``1(System.Object[]) + name: AsStack(params object[]) + href: api/dot-net/Custom.Hybrid.ApiTyped.html#Custom_Hybrid_ApiTyped_AsStack__1_System_Object___ + commentId: M:Custom.Hybrid.ApiTyped.AsStack``1(System.Object[]) + name.vb: AsStack(Of T)(ParamArray Object()) + fullName: Custom.Hybrid.ApiTyped.AsStack(params object[]) + fullName.vb: Custom.Hybrid.ApiTyped.AsStack(Of T)(ParamArray Object()) + nameWithType: ApiTyped.AsStack(params object[]) + nameWithType.vb: ApiTyped.AsStack(Of T)(ParamArray Object()) - uid: Custom.Hybrid.ApiTyped.AsTyped(System.Object,ToSic.Lib.Coding.NoParamOrder,System.Nullable{System.Boolean}) name: AsTyped(object, NoParamOrder, bool?) href: api/dot-net/Custom.Hybrid.ApiTyped.html#Custom_Hybrid_ApiTyped_AsTyped_System_Object_ToSic_Lib_Coding_NoParamOrder_System_Nullable_System_Boolean__ @@ -5358,6 +5367,15 @@ references: isSpec: "True" fullName: Custom.Hybrid.CodeTyped.AsStack nameWithType: CodeTyped.AsStack +- uid: Custom.Hybrid.CodeTyped.AsStack``1(System.Object[]) + name: AsStack(params object[]) + href: api/dot-net/Custom.Hybrid.CodeTyped.html#Custom_Hybrid_CodeTyped_AsStack__1_System_Object___ + commentId: M:Custom.Hybrid.CodeTyped.AsStack``1(System.Object[]) + name.vb: AsStack(Of T)(ParamArray Object()) + fullName: Custom.Hybrid.CodeTyped.AsStack(params object[]) + fullName.vb: Custom.Hybrid.CodeTyped.AsStack(Of T)(ParamArray Object()) + nameWithType: CodeTyped.AsStack(params object[]) + nameWithType.vb: CodeTyped.AsStack(Of T)(ParamArray Object()) - uid: Custom.Hybrid.CodeTyped.AsTyped(System.Object,ToSic.Lib.Coding.NoParamOrder,System.Nullable{System.Boolean}) name: AsTyped(object, NoParamOrder, bool?) href: api/dot-net/Custom.Hybrid.CodeTyped.html#Custom_Hybrid_CodeTyped_AsTyped_System_Object_ToSic_Lib_Coding_NoParamOrder_System_Nullable_System_Boolean__ @@ -6369,6 +6387,15 @@ references: isSpec: "True" fullName: Custom.Hybrid.RazorTyped.AsStack nameWithType: RazorTyped.AsStack +- uid: Custom.Hybrid.RazorTyped.AsStack``1(System.Object[]) + name: AsStack(params object[]) + href: api/dot-net/Custom.Hybrid.RazorTyped.html#Custom_Hybrid_RazorTyped_AsStack__1_System_Object___ + commentId: M:Custom.Hybrid.RazorTyped.AsStack``1(System.Object[]) + name.vb: AsStack(Of T)(ParamArray Object()) + fullName: Custom.Hybrid.RazorTyped.AsStack(params object[]) + fullName.vb: Custom.Hybrid.RazorTyped.AsStack(Of T)(ParamArray Object()) + nameWithType: RazorTyped.AsStack(params object[]) + nameWithType.vb: RazorTyped.AsStack(Of T)(ParamArray Object()) - uid: Custom.Hybrid.RazorTyped.AsTyped(System.Object,ToSic.Lib.Coding.NoParamOrder,System.Nullable{System.Boolean}) name: AsTyped(object, NoParamOrder, bool?) href: api/dot-net/Custom.Hybrid.RazorTyped.html#Custom_Hybrid_RazorTyped_AsTyped_System_Object_ToSic_Lib_Coding_NoParamOrder_System_Nullable_System_Boolean__ @@ -19231,6 +19258,22 @@ references: isSpec: "True" fullName: ToSic.Sxc.Data.ITypedItem.Folder nameWithType: ITypedItem.Folder +- uid: ToSic.Sxc.Data.ITypedItem.Gps(System.String,ToSic.Lib.Coding.NoParamOrder,System.Nullable{System.Boolean}) + name: Gps(string, NoParamOrder, bool?) + href: api/dot-net/ToSic.Sxc.Data.ITypedItem.html#ToSic_Sxc_Data_ITypedItem_Gps_System_String_ToSic_Lib_Coding_NoParamOrder_System_Nullable_System_Boolean__ + commentId: M:ToSic.Sxc.Data.ITypedItem.Gps(System.String,ToSic.Lib.Coding.NoParamOrder,System.Nullable{System.Boolean}) + name.vb: Gps(String, NoParamOrder, Boolean?) + fullName: ToSic.Sxc.Data.ITypedItem.Gps(string, ToSic.Lib.Coding.NoParamOrder, bool?) + fullName.vb: ToSic.Sxc.Data.ITypedItem.Gps(String, ToSic.Lib.Coding.NoParamOrder, Boolean?) + nameWithType: ITypedItem.Gps(string, NoParamOrder, bool?) + nameWithType.vb: ITypedItem.Gps(String, NoParamOrder, Boolean?) +- uid: ToSic.Sxc.Data.ITypedItem.Gps* + name: Gps + href: api/dot-net/ToSic.Sxc.Data.ITypedItem.html#ToSic_Sxc_Data_ITypedItem_Gps_ + commentId: Overload:ToSic.Sxc.Data.ITypedItem.Gps + isSpec: "True" + fullName: ToSic.Sxc.Data.ITypedItem.Gps + nameWithType: ITypedItem.Gps - uid: ToSic.Sxc.Data.ITypedItem.Guid name: Guid href: api/dot-net/ToSic.Sxc.Data.ITypedItem.html#ToSic_Sxc_Data_ITypedItem_Guid @@ -19452,38 +19495,6 @@ references: commentId: T:ToSic.Sxc.Data.ITypedStack fullName: ToSic.Sxc.Data.ITypedStack nameWithType: ITypedStack -- uid: ToSic.Sxc.Data.ITypedStack.Child(System.String,ToSic.Lib.Coding.NoParamOrder,System.Nullable{System.Boolean}) - name: Child(string, NoParamOrder, bool?) - href: api/dot-net/ToSic.Sxc.Data.ITypedStack.html#ToSic_Sxc_Data_ITypedStack_Child_System_String_ToSic_Lib_Coding_NoParamOrder_System_Nullable_System_Boolean__ - commentId: M:ToSic.Sxc.Data.ITypedStack.Child(System.String,ToSic.Lib.Coding.NoParamOrder,System.Nullable{System.Boolean}) - name.vb: Child(String, NoParamOrder, Boolean?) - fullName: ToSic.Sxc.Data.ITypedStack.Child(string, ToSic.Lib.Coding.NoParamOrder, bool?) - fullName.vb: ToSic.Sxc.Data.ITypedStack.Child(String, ToSic.Lib.Coding.NoParamOrder, Boolean?) - nameWithType: ITypedStack.Child(string, NoParamOrder, bool?) - nameWithType.vb: ITypedStack.Child(String, NoParamOrder, Boolean?) -- uid: ToSic.Sxc.Data.ITypedStack.Child* - name: Child - href: api/dot-net/ToSic.Sxc.Data.ITypedStack.html#ToSic_Sxc_Data_ITypedStack_Child_ - commentId: Overload:ToSic.Sxc.Data.ITypedStack.Child - isSpec: "True" - fullName: ToSic.Sxc.Data.ITypedStack.Child - nameWithType: ITypedStack.Child -- uid: ToSic.Sxc.Data.ITypedStack.Children(System.String,ToSic.Lib.Coding.NoParamOrder,System.String,System.Nullable{System.Boolean}) - name: Children(string, NoParamOrder, string, bool?) - href: api/dot-net/ToSic.Sxc.Data.ITypedStack.html#ToSic_Sxc_Data_ITypedStack_Children_System_String_ToSic_Lib_Coding_NoParamOrder_System_String_System_Nullable_System_Boolean__ - commentId: M:ToSic.Sxc.Data.ITypedStack.Children(System.String,ToSic.Lib.Coding.NoParamOrder,System.String,System.Nullable{System.Boolean}) - name.vb: Children(String, NoParamOrder, String, Boolean?) - fullName: ToSic.Sxc.Data.ITypedStack.Children(string, ToSic.Lib.Coding.NoParamOrder, string, bool?) - fullName.vb: ToSic.Sxc.Data.ITypedStack.Children(String, ToSic.Lib.Coding.NoParamOrder, String, Boolean?) - nameWithType: ITypedStack.Children(string, NoParamOrder, string, bool?) - nameWithType.vb: ITypedStack.Children(String, NoParamOrder, String, Boolean?) -- uid: ToSic.Sxc.Data.ITypedStack.Children* - name: Children - href: api/dot-net/ToSic.Sxc.Data.ITypedStack.html#ToSic_Sxc_Data_ITypedStack_Children_ - commentId: Overload:ToSic.Sxc.Data.ITypedStack.Children - isSpec: "True" - fullName: ToSic.Sxc.Data.ITypedStack.Children - nameWithType: ITypedStack.Children - uid: ToSic.Sxc.DataSources name: ToSic.Sxc.DataSources href: api/dot-net/ToSic.Sxc.DataSources.html