Skip to content

Commit

Permalink
docs 16.03
Browse files Browse the repository at this point in the history
  • Loading branch information
@iJungleboy
iJungleboy committed Aug 10, 2023
1 parent cdfc492 commit 0b4bc9a
Show file tree
Hide file tree
Showing 32 changed files with 764 additions and 642 deletions.
104 changes: 68 additions & 36 deletions docs/api/dot-net/Custom.Hybrid.ApiPro.html
View file

Large diffs are not rendered by default.

82 changes: 56 additions & 26 deletions docs/api/dot-net/Custom.Hybrid.CodePro.html
View file

Large diffs are not rendered by default.

72 changes: 51 additions & 21 deletions docs/api/dot-net/Custom.Hybrid.RazorPro.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -303,9 +303,7 @@ <h5 class="overrides">Overrides</h5>
</span>
<a id="Custom_Hybrid_RazorPro_Kit_" data-uid="Custom.Hybrid.RazorPro.Kit*"></a>
<h4 id="Custom_Hybrid_RazorPro_Kit" data-uid="Custom.Hybrid.RazorPro.Kit">Kit</h4>
<div class="markdown level1 summary"><p>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.</p>
</div>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="declaration">Declaration</h5>
<div class="codewrapper">
Expand Down Expand Up @@ -756,13 +754,13 @@ <h5 class="returns">Returns</h5>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/2sic/2sxc/new/develop/apiSpec/new?filename=Custom_Hybrid_RazorPro_AsItem_System_Object_System_String_System_Nullable_System_Boolean__.md&amp;value=---%0Auid%3A%20Custom.Hybrid.RazorPro.AsItem(System.Object%2CSystem.String%2CSystem.Nullable%7BSystem.Boolean%7D)%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
<a href="https://github.com/2sic/2sxc/new/develop/apiSpec/new?filename=Custom_Hybrid_RazorPro_AsItem_System_Object_System_String_System_Nullable_System_Boolean__System_Nullable_System_Boolean__.md&amp;value=---%0Auid%3A%20Custom.Hybrid.RazorPro.AsItem(System.Object%2CSystem.String%2CSystem.Nullable%7BSystem.Boolean%7D%2CSystem.Nullable%7BSystem.Boolean%7D)%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/2sic/2sxc/blob/develop/Src/Dnn/ToSic.Sxc.Dnn.Razor/Custom/Hybrid/RazorPro.cs/#L105">View Source</a>
</span>
<a id="Custom_Hybrid_RazorPro_AsItem_" data-uid="Custom.Hybrid.RazorPro.AsItem*"></a>
<h4 id="Custom_Hybrid_RazorPro_AsItem_System_Object_System_String_System_Nullable_System_Boolean__" data-uid="Custom.Hybrid.RazorPro.AsItem(System.Object,System.String,System.Nullable{System.Boolean})">AsItem(object, string, bool?)</h4>
<h4 id="Custom_Hybrid_RazorPro_AsItem_System_Object_System_String_System_Nullable_System_Boolean__System_Nullable_System_Boolean__" data-uid="Custom.Hybrid.RazorPro.AsItem(System.Object,System.String,System.Nullable{System.Boolean},System.Nullable{System.Boolean})">AsItem(object, string, bool?, bool?)</h4>
<div class="markdown level1 summary"><p>Convert something to a <a class="xref" href="ToSic.Sxc.Data.ITypedItem.html">ITypedItem</a>.
This works for all kinds of <a class="xref" href="ToSic.Eav.Data.IEntity.html">IEntity</a>s,
<a class="xref" href="ToSic.Sxc.Data.IDynamicEntity.html">IDynamicEntity</a>s as well as Lists/IEnumerables of those.</p>
Expand All @@ -773,7 +771,7 @@ <h4 id="Custom_Hybrid_RazorPro_AsItem_System_Object_System_String_System_Nullabl
<div class="markdown level1 conceptual"></div>
<h5 class="declaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public ITypedItem AsItem(object target, string noParamOrder = &quot;Params must be named (https://go.2sxc.org/named-params)&quot;, bool? strict = null)</code></pre>
<pre><code class="lang-csharp hljs">public ITypedItem AsItem(object data, string noParamOrder = &quot;Params must be named (https://go.2sxc.org/named-params)&quot;, bool? strict = null, bool? mock = null)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-condensed">
Expand All @@ -787,8 +785,9 @@ <h5 class="parameters">Parameters</h5>
<tbody>
<tr>
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></td>
<td><span class="parametername">target</span></td>
<td></td>
<td><span class="parametername">data</span></td>
<td><p>An original object which can be converted to a TypedItem, such as a <a class="xref" href="ToSic.Eav.Data.IEntity.html">IEntity</a> .</p>
</td>
</tr>
<tr>
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></td>
Expand All @@ -799,7 +798,13 @@ <h5 class="parameters">Parameters</h5>
<tr>
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a>?</td>
<td><span class="parametername">strict</span></td>
<td><p>determine if the items returned will do strict property-name checking; default is true</p>
<td><p>make the resulting object <a class="xref" href="../../net-code/conventions/typed-required/index.html">strict</a>, default <code>true</code></p>
</td>
</tr>
<tr>
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a>?</td>
<td><span class="parametername">mock</span></td>
<td><p>Specify that the data is fake/mock data, which should pretend to be an Item. Default is <code>false</code></p>
</td>
</tr>
</tbody>
Expand All @@ -819,7 +824,7 @@ <h5 class="returns">Returns</h5>
</tr>
</tbody>
</table>
<h5 id="Custom_Hybrid_RazorPro_AsItem_System_Object_System_String_System_Nullable_System_Boolean___remarks">Remarks</h5>
<h5 id="Custom_Hybrid_RazorPro_AsItem_System_Object_System_String_System_Nullable_System_Boolean__System_Nullable_System_Boolean___remarks">Remarks</h5>
<div class="markdown level1 remarks"><p>New in v16.02</p>
</div>
<span class="small pull-right mobile-hide">
Expand Down Expand Up @@ -863,7 +868,7 @@ <h5 class="parameters">Parameters</h5>
<tr>
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a>?</td>
<td><span class="parametername">strict</span></td>
<td><p>determine if the items returned will do strict property-name checking; default is true</p>
<td><p>make the resulting object <a class="xref" href="../../net-code/conventions/typed-required/index.html">strict</a>, default <code>true</code></p>
</td>
</tr>
</tbody>
Expand Down Expand Up @@ -891,7 +896,7 @@ <h5 id="Custom_Hybrid_RazorPro_AsItems_System_Object_System_String_System_Nullab
<a href="https://github.com/2sic/2sxc/new/develop/apiSpec/new?filename=Custom_Hybrid_RazorPro_AsStack_System_Object___.md&amp;value=---%0Auid%3A%20Custom.Hybrid.RazorPro.AsStack(System.Object%5B%5D)%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/2sic/2sxc/blob/develop/Src/Dnn/ToSic.Sxc.Dnn.Razor/Custom/Hybrid/RazorPro.cs/#L122">View Source</a>
<a href="https://github.com/2sic/2sxc/blob/develop/Src/Dnn/ToSic.Sxc.Dnn.Razor/Custom/Hybrid/RazorPro.cs/#L124">View Source</a>
</span>
<a id="Custom_Hybrid_RazorPro_AsStack_" data-uid="Custom.Hybrid.RazorPro.AsStack*"></a>
<h4 id="Custom_Hybrid_RazorPro_AsStack_System_Object___" data-uid="Custom.Hybrid.RazorPro.AsStack(System.Object[])">AsStack(params object[])</h4>
Expand Down Expand Up @@ -937,21 +942,21 @@ <h5 class="returns">Returns</h5>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/2sic/2sxc/new/develop/apiSpec/new?filename=Custom_Hybrid_RazorPro_AsTyped_System_Object_.md&amp;value=---%0Auid%3A%20Custom.Hybrid.RazorPro.AsTyped(System.Object)%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
<a href="https://github.com/2sic/2sxc/new/develop/apiSpec/new?filename=Custom_Hybrid_RazorPro_AsTyped_System_Object_System_String_System_Nullable_System_Boolean__.md&amp;value=---%0Auid%3A%20Custom.Hybrid.RazorPro.AsTyped(System.Object%2CSystem.String%2CSystem.Nullable%7BSystem.Boolean%7D)%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/2sic/2sxc/blob/develop/Src/Dnn/ToSic.Sxc.Dnn.Razor/Custom/Hybrid/RazorPro.cs/#L116">View Source</a>
</span>
<a id="Custom_Hybrid_RazorPro_AsTyped_" data-uid="Custom.Hybrid.RazorPro.AsTyped*"></a>
<h4 id="Custom_Hybrid_RazorPro_AsTyped_System_Object_" data-uid="Custom.Hybrid.RazorPro.AsTyped(System.Object)">AsTyped(object)</h4>
<h4 id="Custom_Hybrid_RazorPro_AsTyped_System_Object_System_String_System_Nullable_System_Boolean__" data-uid="Custom.Hybrid.RazorPro.AsTyped(System.Object,System.String,System.Nullable{System.Boolean})">AsTyped(object, string, bool?)</h4>
<div class="markdown level1 summary"><p>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.</p>
<p>If you have an array of such objects, use <a class="xref" href="ToSic.Sxc.Code.IDynamicCode16.html#ToSic.Sxc.Code.IDynamicCode16.AsTypedList(System.Object)">AsTypedList(object)</a>.</p>
<p>If you have an array of such objects, use <a class="xref" href="ToSic.Sxc.Code.IDynamicCode16.html#ToSic.Sxc.Code.IDynamicCode16.AsTypedList(System.Object,System.String,System.Nullable{System.Boolean})">AsTypedList(object, string, bool?)</a>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="declaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public ITyped AsTyped(object original)</code></pre>
<pre><code class="lang-csharp hljs">public ITyped AsTyped(object original, string noParamOrder = &quot;Params must be named (https://go.2sxc.org/named-params)&quot;, bool? strict = null)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-condensed">
Expand All @@ -968,6 +973,18 @@ <h5 class="parameters">Parameters</h5>
<td><span class="parametername">original</span></td>
<td></td>
</tr>
<tr>
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></td>
<td><span class="parametername">noParamOrder</span></td>
<td><p>see <a class="xref" href="../../net-code/conventions/named-parameters.html">Convention: Named Parameters</a></p>
</td>
</tr>
<tr>
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a>?</td>
<td><span class="parametername">strict</span></td>
<td><p>make the resulting object <a class="xref" href="../../net-code/conventions/typed-required/index.html">strict</a>, default <code>true</code></p>
</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
Expand All @@ -987,19 +1004,19 @@ <h5 class="returns">Returns</h5>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/2sic/2sxc/new/develop/apiSpec/new?filename=Custom_Hybrid_RazorPro_AsTypedList_System_Object_.md&amp;value=---%0Auid%3A%20Custom.Hybrid.RazorPro.AsTypedList(System.Object)%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
<a href="https://github.com/2sic/2sxc/new/develop/apiSpec/new?filename=Custom_Hybrid_RazorPro_AsTypedList_System_Object_System_String_System_Nullable_System_Boolean__.md&amp;value=---%0Auid%3A%20Custom.Hybrid.RazorPro.AsTypedList(System.Object%2CSystem.String%2CSystem.Nullable%7BSystem.Boolean%7D)%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/2sic/2sxc/blob/develop/Src/Dnn/ToSic.Sxc.Dnn.Razor/Custom/Hybrid/RazorPro.cs/#L119">View Source</a>
<a href="https://github.com/2sic/2sxc/blob/develop/Src/Dnn/ToSic.Sxc.Dnn.Razor/Custom/Hybrid/RazorPro.cs/#L120">View Source</a>
</span>
<a id="Custom_Hybrid_RazorPro_AsTypedList_" data-uid="Custom.Hybrid.RazorPro.AsTypedList*"></a>
<h4 id="Custom_Hybrid_RazorPro_AsTypedList_System_Object_" data-uid="Custom.Hybrid.RazorPro.AsTypedList(System.Object)">AsTypedList(object)</h4>
<h4 id="Custom_Hybrid_RazorPro_AsTypedList_System_Object_System_String_System_Nullable_System_Boolean__" data-uid="Custom.Hybrid.RazorPro.AsTypedList(System.Object,System.String,System.Nullable{System.Boolean})">AsTypedList(object, string, bool?)</h4>
<div class="markdown level1 summary"><p>Create a list</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="declaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public IEnumerable&lt;ITyped&gt; AsTypedList(object list)</code></pre>
<pre><code class="lang-csharp hljs">public IEnumerable&lt;ITyped&gt; AsTypedList(object list, string noParamOrder = &quot;Params must be named (https://go.2sxc.org/named-params)&quot;, bool? strict = null)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-condensed">
Expand All @@ -1014,7 +1031,20 @@ <h5 class="parameters">Parameters</h5>
<tr>
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></td>
<td><span class="parametername">list</span></td>
<td></td>
<td><p>List/Enumerable object containing a bunch of items to make typed</p>
</td>
</tr>
<tr>
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></td>
<td><span class="parametername">noParamOrder</span></td>
<td><p>see <a class="xref" href="../../net-code/conventions/named-parameters.html">Convention: Named Parameters</a></p>
</td>
</tr>
<tr>
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a>?</td>
<td><span class="parametername">strict</span></td>
<td><p>make the resulting object <a class="xref" href="../../net-code/conventions/typed-required/index.html">strict</a>, default <code>true</code></p>
</td>
</tr>
</tbody>
</table>
Expand Down
Loading

0 comments on commit 0b4bc9a

Please sign in to comment.