Published Docs

fileformat-slides · Dec 19, 2023 · d46db9f · d46db9f
1 parent 0a3501f
commit d46db9f
Show file tree

Hide file tree

Showing 11 changed files with 967 additions and 33 deletions.
diff --git a/api/FileFormat.Slides.Common.Enumerations.TextAlignment.html b/api/FileFormat.Slides.Common.Enumerations.TextAlignment.html
@@ -123,6 +123,8 @@ <h2 id="fields">Fields
     <dd></dd>
     <dt id="FileFormat_Slides_Common_Enumerations_TextAlignment_Left"><code>Left = 0</code></dt>
     <dd></dd>
+    <dt id="FileFormat_Slides_Common_Enumerations_TextAlignment_None"><code>None = 3</code></dt>
+    <dd></dd>
     <dt id="FileFormat_Slides_Common_Enumerations_TextAlignment_Right"><code>Right = 1</code></dt>
     <dd></dd>
   </dl>

diff --git a/api/FileFormat.Slides.Presentation.html b/api/FileFormat.Slides.Presentation.html
@@ -250,7 +250,7 @@ <h4 class="section" id="FileFormat_Slides_Presentation_Create_System_String__exa
 
   <h3 id="FileFormat_Slides_Presentation_ExtractAndSaveImages_System_String_" data-uid="FileFormat.Slides.Presentation.ExtractAndSaveImages(System.String)">
   ExtractAndSaveImages(string)
-  <a class="header-action link-secondary" title="View source" href="https://github.com/umar320/FileFormat.Slides/blob/main/FileFormat.Slides/Presentation.cs/#L146"><i class="bi bi-code-slash"></i></a>
+  <a class="header-action link-secondary" title="View source" href="https://github.com/umar320/FileFormat.Slides/blob/main/FileFormat.Slides/Presentation.cs/#L147"><i class="bi bi-code-slash"></i></a>
   </h3>
 
   <div class="markdown level1 summary"><p>Extract and save images of a presentation into a director</p>
@@ -283,7 +283,7 @@ <h4 class="section">Parameters</h4>
 
   <h3 id="FileFormat_Slides_Presentation_GetSlides" data-uid="FileFormat.Slides.Presentation.GetSlides">
   GetSlides()
-  <a class="header-action link-secondary" title="View source" href="https://github.com/umar320/FileFormat.Slides/blob/main/FileFormat.Slides/Presentation.cs/#L120"><i class="bi bi-code-slash"></i></a>
+  <a class="header-action link-secondary" title="View source" href="https://github.com/umar320/FileFormat.Slides/blob/main/FileFormat.Slides/Presentation.cs/#L121"><i class="bi bi-code-slash"></i></a>
   </h3>
 
   <div class="markdown level1 summary"><p>Method to get the list of all slides of a presentation</p>
@@ -321,7 +321,7 @@ <h4 class="section" id="FileFormat_Slides_Presentation_GetSlides_examples">Examp
 
   <h3 id="FileFormat_Slides_Presentation_InsertSlideAt_System_Int32_FileFormat_Slides_Slide_" data-uid="FileFormat.Slides.Presentation.InsertSlideAt(System.Int32,FileFormat.Slides.Slide)">
   InsertSlideAt(int, Slide)
-  <a class="header-action link-secondary" title="View source" href="https://github.com/umar320/FileFormat.Slides/blob/main/FileFormat.Slides/Presentation.cs/#L171"><i class="bi bi-code-slash"></i></a>
+  <a class="header-action link-secondary" title="View source" href="https://github.com/umar320/FileFormat.Slides/blob/main/FileFormat.Slides/Presentation.cs/#L172"><i class="bi bi-code-slash"></i></a>
   </h3>
 
   <div class="markdown level1 summary"><p>Method to insert a slide at a specific index</p>
@@ -409,7 +409,7 @@ <h4 class="section" id="FileFormat_Slides_Presentation_Open_System_String__examp
 
   <h3 id="FileFormat_Slides_Presentation_RemoveSlide_System_Int32_" data-uid="FileFormat.Slides.Presentation.RemoveSlide(System.Int32)">
   RemoveSlide(int)
-  <a class="header-action link-secondary" title="View source" href="https://github.com/umar320/FileFormat.Slides/blob/main/FileFormat.Slides/Presentation.cs/#L162"><i class="bi bi-code-slash"></i></a>
+  <a class="header-action link-secondary" title="View source" href="https://github.com/umar320/FileFormat.Slides/blob/main/FileFormat.Slides/Presentation.cs/#L163"><i class="bi bi-code-slash"></i></a>
   </h3>
 
   <div class="markdown level1 summary"><p>Method to remove a slide at a specific index</p>
@@ -453,7 +453,7 @@ <h4 class="section" id="FileFormat_Slides_Presentation_RemoveSlide_System_Int32_
 
   <h3 id="FileFormat_Slides_Presentation_Save" data-uid="FileFormat.Slides.Presentation.Save">
   Save()
-  <a class="header-action link-secondary" title="View source" href="https://github.com/umar320/FileFormat.Slides/blob/main/FileFormat.Slides/Presentation.cs/#L180"><i class="bi bi-code-slash"></i></a>
+  <a class="header-action link-secondary" title="View source" href="https://github.com/umar320/FileFormat.Slides/blob/main/FileFormat.Slides/Presentation.cs/#L181"><i class="bi bi-code-slash"></i></a>
   </h3>
 
   <div class="markdown level1 summary"><p>Method to save the new or changed presentation.</p>

diff --git a/api/FileFormat.Slides.Slide.html b/api/FileFormat.Slides.Slide.html
@@ -159,7 +159,7 @@ <h2 class="section" id="constructors">Constructors
 
   <h3 id="FileFormat_Slides_Slide__ctor" data-uid="FileFormat.Slides.Slide.#ctor">
   Slide()
-  <a class="header-action link-secondary" title="View source" href="https://github.com/umar320/FileFormat.Slides/blob/main/FileFormat.Slides/Slide.cs/#L51"><i class="bi bi-code-slash"></i></a>
+  <a class="header-action link-secondary" title="View source" href="https://github.com/umar320/FileFormat.Slides/blob/main/FileFormat.Slides/Slide.cs/#L56"><i class="bi bi-code-slash"></i></a>
   </h3>
 
   <div class="markdown level1 summary"><p>Constructor for the Slide class.</p>
@@ -189,7 +189,7 @@ <h4 class="section" id="FileFormat_Slides_Slide__ctor_remarks">Remarks</h4>
 
   <h3 id="FileFormat_Slides_Slide__ctor_System_Boolean_" data-uid="FileFormat.Slides.Slide.#ctor(System.Boolean)">
   Slide(bool)
-  <a class="header-action link-secondary" title="View source" href="https://github.com/umar320/FileFormat.Slides/blob/main/FileFormat.Slides/Slide.cs/#L69"><i class="bi bi-code-slash"></i></a>
+  <a class="header-action link-secondary" title="View source" href="https://github.com/umar320/FileFormat.Slides/blob/main/FileFormat.Slides/Slide.cs/#L75"><i class="bi bi-code-slash"></i></a>
   </h3>
 
   <div class="markdown level1 summary"></div>
@@ -220,11 +220,43 @@ <h2 class="section" id="properties">Properties
 </h2>
 
 
+  <a id="FileFormat_Slides_Slide_BackgroundColor_" data-uid="FileFormat.Slides.Slide.BackgroundColor*"></a>
+
+  <h3 id="FileFormat_Slides_Slide_BackgroundColor" data-uid="FileFormat.Slides.Slide.BackgroundColor">
+  BackgroundColor
+  <a class="header-action link-secondary" title="View source" href="https://github.com/umar320/FileFormat.Slides/blob/main/FileFormat.Slides/Slide.cs/#L47"><i class="bi bi-code-slash"></i></a>
+  </h3>
+
+  <div class="markdown level1 summary"><p>Property to set background color of a slide.</p>
+</div>
+  <div class="markdown level1 conceptual"></div>
+
+  <div class="codewrapper">
+    <pre><code class="lang-csharp hljs">public string BackgroundColor { get; set; }</code></pre>
+  </div>
+
+
+
+
+
+  <h4 class="section">Property Value</h4>
+  <dl class="parameters">
+    <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
+    <dd></dd>
+  </dl>
+
+
+
+
+
+
+
+
   <a id="FileFormat_Slides_Slide_Images_" data-uid="FileFormat.Slides.Slide.Images*"></a>
 
   <h3 id="FileFormat_Slides_Slide_Images" data-uid="FileFormat.Slides.Slide.Images">
   Images
-  <a class="header-action link-secondary" title="View source" href="https://github.com/umar320/FileFormat.Slides/blob/main/FileFormat.Slides/Slide.cs/#L42"><i class="bi bi-code-slash"></i></a>
+  <a class="header-action link-secondary" title="View source" href="https://github.com/umar320/FileFormat.Slides/blob/main/FileFormat.Slides/Slide.cs/#L43"><i class="bi bi-code-slash"></i></a>
   </h3>
 
   <div class="markdown level1 summary"><p>Property contains the list of all images within a slide.</p>
@@ -256,7 +288,7 @@ <h4 class="section">Property Value</h4>
 
   <h3 id="FileFormat_Slides_Slide_RelationshipId" data-uid="FileFormat.Slides.Slide.RelationshipId">
   RelationshipId
-  <a class="header-action link-secondary" title="View source" href="https://github.com/umar320/FileFormat.Slides/blob/main/FileFormat.Slides/Slide.cs/#L33"><i class="bi bi-code-slash"></i></a>
+  <a class="header-action link-secondary" title="View source" href="https://github.com/umar320/FileFormat.Slides/blob/main/FileFormat.Slides/Slide.cs/#L34"><i class="bi bi-code-slash"></i></a>
   </h3>
 
   <div class="markdown level1 summary"><p>Property for the relationship Id.</p>
@@ -288,7 +320,7 @@ <h4 class="section">Property Value</h4>
 
   <h3 id="FileFormat_Slides_Slide_SlideFacade" data-uid="FileFormat.Slides.Slide.SlideFacade">
   SlideFacade
-  <a class="header-action link-secondary" title="View source" href="https://github.com/umar320/FileFormat.Slides/blob/main/FileFormat.Slides/Slide.cs/#L25"><i class="bi bi-code-slash"></i></a>
+  <a class="header-action link-secondary" title="View source" href="https://github.com/umar320/FileFormat.Slides/blob/main/FileFormat.Slides/Slide.cs/#L26"><i class="bi bi-code-slash"></i></a>
   </h3>
 
   <div class="markdown level1 summary"><p>Property for respective Slide Facade.</p>
@@ -320,7 +352,7 @@ <h4 class="section">Property Value</h4>
 
   <h3 id="FileFormat_Slides_Slide_SlideIndex" data-uid="FileFormat.Slides.Slide.SlideIndex">
   SlideIndex
-  <a class="header-action link-secondary" title="View source" href="https://github.com/umar320/FileFormat.Slides/blob/main/FileFormat.Slides/Slide.cs/#L38"><i class="bi bi-code-slash"></i></a>
+  <a class="header-action link-secondary" title="View source" href="https://github.com/umar320/FileFormat.Slides/blob/main/FileFormat.Slides/Slide.cs/#L39"><i class="bi bi-code-slash"></i></a>
   </h3>
 
   <div class="markdown level1 summary"><p>Property to hold the index of the slide.</p>
@@ -352,7 +384,7 @@ <h4 class="section">Property Value</h4>
 
   <h3 id="FileFormat_Slides_Slide_TextShapes" data-uid="FileFormat.Slides.Slide.TextShapes">
   TextShapes
-  <a class="header-action link-secondary" title="View source" href="https://github.com/umar320/FileFormat.Slides/blob/main/FileFormat.Slides/Slide.cs/#L29"><i class="bi bi-code-slash"></i></a>
+  <a class="header-action link-secondary" title="View source" href="https://github.com/umar320/FileFormat.Slides/blob/main/FileFormat.Slides/Slide.cs/#L30"><i class="bi bi-code-slash"></i></a>
   </h3>
 
   <div class="markdown level1 summary"><p>Property contains the list of all text shapes.</p>
@@ -388,7 +420,7 @@ <h2 class="section" id="methods">Methods
 
   <h3 id="FileFormat_Slides_Slide_AddImage_FileFormat_Slides_Image_" data-uid="FileFormat.Slides.Slide.AddImage(FileFormat.Slides.Image)">
   AddImage(Image)
-  <a class="header-action link-secondary" title="View source" href="https://github.com/umar320/FileFormat.Slides/blob/main/FileFormat.Slides/Slide.cs/#L103"><i class="bi bi-code-slash"></i></a>
+  <a class="header-action link-secondary" title="View source" href="https://github.com/umar320/FileFormat.Slides/blob/main/FileFormat.Slides/Slide.cs/#L143"><i class="bi bi-code-slash"></i></a>
   </h3>
 
   <div class="markdown level1 summary"><p>Method to add images to a slide.</p>
@@ -421,7 +453,7 @@ <h4 class="section">Parameters</h4>
 
   <h3 id="FileFormat_Slides_Slide_AddTextShapes_FileFormat_Slides_TextShape_" data-uid="FileFormat.Slides.Slide.AddTextShapes(FileFormat.Slides.TextShape)">
   AddTextShapes(TextShape)
-  <a class="header-action link-secondary" title="View source" href="https://github.com/umar320/FileFormat.Slides/blob/main/FileFormat.Slides/Slide.cs/#L84"><i class="bi bi-code-slash"></i></a>
+  <a class="header-action link-secondary" title="View source" href="https://github.com/umar320/FileFormat.Slides/blob/main/FileFormat.Slides/Slide.cs/#L91"><i class="bi bi-code-slash"></i></a>
   </h3>
 
   <div class="markdown level1 summary"><p>Method to add a text shape in a slide.</p>
@@ -450,11 +482,44 @@ <h4 class="section">Parameters</h4>
 
 
 
+  <a id="FileFormat_Slides_Slide_AddTextShapes_" data-uid="FileFormat.Slides.Slide.AddTextShapes*"></a>
+
+  <h3 id="FileFormat_Slides_Slide_AddTextShapes_FileFormat_Slides_TextShape_System_Collections_Generic_List_FileFormat_Slides_TextSegment__" data-uid="FileFormat.Slides.Slide.AddTextShapes(FileFormat.Slides.TextShape,System.Collections.Generic.List{FileFormat.Slides.TextSegment})">
+  AddTextShapes(TextShape, List&lt;TextSegment&gt;)
+  <a class="header-action link-secondary" title="View source" href="https://github.com/umar320/FileFormat.Slides/blob/main/FileFormat.Slides/Slide.cs/#L118"><i class="bi bi-code-slash"></i></a>
+  </h3>
+
+  <div class="markdown level1 summary"></div>
+  <div class="markdown level1 conceptual"></div>
+
+  <div class="codewrapper">
+    <pre><code class="lang-csharp hljs">public void AddTextShapes(TextShape textShape, List&lt;TextSegment&gt; textSegments)</code></pre>
+  </div>
+
+  <h4 class="section">Parameters</h4>
+  <dl class="parameters">
+    <dt><code>textShape</code> <a class="xref" href="FileFormat.Slides.TextShape.html">TextShape</a></dt>
+    <dd></dd>
+    <dt><code>textSegments</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.list-1">List</a>&lt;<a class="xref" href="FileFormat.Slides.TextSegment.html">TextSegment</a>&gt;</dt>
+    <dd></dd>
+  </dl>
+
+
+
+
+
+
+
+
+
+
+
+
   <a id="FileFormat_Slides_Slide_GetTextShapesByText_" data-uid="FileFormat.Slides.Slide.GetTextShapesByText*"></a>
 
   <h3 id="FileFormat_Slides_Slide_GetTextShapesByText_System_String_" data-uid="FileFormat.Slides.Slide.GetTextShapesByText(System.String)">
   GetTextShapesByText(string)
-  <a class="header-action link-secondary" title="View source" href="https://github.com/umar320/FileFormat.Slides/blob/main/FileFormat.Slides/Slide.cs/#L128"><i class="bi bi-code-slash"></i></a>
+  <a class="header-action link-secondary" title="View source" href="https://github.com/umar320/FileFormat.Slides/blob/main/FileFormat.Slides/Slide.cs/#L168"><i class="bi bi-code-slash"></i></a>
   </h3>
 
   <div class="markdown level1 summary"><p>Get text shapes by searching a text term.</p>