clean up docs\spreadsheet\structure-of-a-spreadsheetml-document.md

Author: mikeebowen

docs/spreadsheet/structure-of-a-spreadsheetml-document.md

@@ -11,19 +11,19 @@ ms.suite: office
 ms.author: o365devx
 author: o365devx
 ms.topic: conceptual
-ms.date: 11/01/2017
+ms.date: 01/14/2025
 ms.localizationpriority: high
 ---
 # Structure of a SpreadsheetML document
 
-The document structure of a **SpreadsheetML**
-document consists of the \<**workbook**\>
-element that contains \<**sheets**\> and
-\<**sheet**\> elements that reference the
+The document structure of a `SpreadsheetML`
+document consists of the `<workbook/>`
+element that contains `<sheets/>` and
+`<sheet/>` elements that reference the
 worksheets in the workbook. A separate XML file is created for each
 worksheet. These elements are the minimum elements required for a valid
 spreadsheet document. In addition, a spreadsheet document might contain
-\<**table**\>, \<**chartsheet**\>, \<**pivotTableDefinition**\>, or other spreadsheet
+`<table/>`, `<chartsheet/>`, `<pivotTableDefinition/>`, or other spreadsheet
 related elements.
 
 [!include[Add-ins note](../includes/addinsnote.md)]
@@ -32,25 +32,25 @@ related elements.
 ## Important Spreadsheet Parts
 
 Using the Open XML SDK for Office, you can create document structure
-and content that uses strongly-typed classes that correspond to **SpreadsheetML** elements. You can find these
-classes in the **DocumentFormat.OpenXML.Spreadsheet** namespace. The
+and content that uses strongly-typed classes that correspond to `SpreadsheetML` elements. You can find these
+classes in the `DocumentFormat.OpenXML.Spreadsheet` namespace. The
 following table lists the class names of the classes that correspond to
 some of the important spreadsheet elements.
 
 
 | Package Part| Top Level SpreadsheetML Element | Open XML SDK Class | Description|
 |:------------|:--------------------------------|:-----------------------|:-----------|
-| Workbook  |   workbook  |  <xref:DocumentFormat.OpenXml.Spreadsheet.Workbook>   |   The root element for the main document part.|
-| Worksheet  |  worksheet     |    <xref:DocumentFormat.OpenXml.Spreadsheet.Worksheet> | A type of sheet that represent a grid of cells that contains text, numbers, dates or formulas. For more information, see [Working with sheets](working-with-sheets.md).  |
-|Chart Sheet |  chartsheet  | <xref:DocumentFormat.OpenXml.Spreadsheet.Chartsheet> | A sheet that represents a chart that is stored as its own sheet. For more information, see [Working with sheets](working-with-sheets.md).  |
-| Table    |    table    |     <xref:DocumentFormat.OpenXml.Spreadsheet.Table>  | A logical construct that specifies that a range of data belongs to a single dataset. For more information, see [Working with SpreadsheetML tables](overview.md).  |
-|Pivot Table       | <xref:DocumentFormat.OpenXml.Spreadsheet.PivotTableDefinition> |  <xref:DocumentFormat.OpenXml.Spreadsheet.PivotTableDefinition>  |  A logical construct that displays aggregated view of data in an understandable layout. For more information, see [Working with PivotTables](working-with-pivottables.md).  |
-|Pivot Cache  |   pivotCacheDefinition  | <xref:DocumentFormat.OpenXml.Spreadsheet.PivotCacheDefinition> |  A construct that defines the source of the data in the PivotTable. For more information, see [Working with PivotTables](working-with-pivottables.md).  |
-|Pivot Cache Records |  pivotCacheRecords  |  <xref:DocumentFormat.OpenXml.Spreadsheet.PivotCacheRecords>  |  A cache of the source data of the PivotTable. For more information, see [Working with PivotTables](working-with-pivottables.md). |
-| Calculation Chain | calcChain  |  <xref:DocumentFormat.OpenXml.Spreadsheet.CalculationChain> | A construct that specifies the order in which cells in the workbook were last calculated. For more information, see [Working with the calculation chain](working-with-the-calculation-chain.md).  |
-|Shared String Table |  sst  |  <xref:DocumentFormat.OpenXml.Spreadsheet.SharedStringTable>     | A construct that contains one occurrence of each unique string that occurs on all worksheets in a workbook. For more information, see [Working with the shared string table](working-with-the-shared-string-table.md). |
-|Conditional Formatting |   conditionalFormatting   | <xref:DocumentFormat.OpenXml.Spreadsheet.ConditionalFormatting>  |  A construct that defines a format applied to a cell or series of cells. For more information, see [Working with conditional formatting](working-with-conditional-formatting.md).   |
-| Formulas  |      f    |  <xref:DocumentFormat.OpenXml.Spreadsheet.CellFormula>  |  A construct that defines the formula text for a cell that contains a formula. For more information, see [Working with formulas](working-with-formulas.md).  |
+| Workbook  |   `<workbook/>`  |  <xref:DocumentFormat.OpenXml.Spreadsheet.Workbook>   |   The root element for the main document part.|
+| Worksheet  |  `<worksheet/>`     |    <xref:DocumentFormat.OpenXml.Spreadsheet.Worksheet> | A type of sheet that represent a grid of cells that contains text, numbers, dates or formulas. For more information, see [Working with sheets](working-with-sheets.md).  |
+|Chart Sheet |  `<chartsheet/>`  | <xref:DocumentFormat.OpenXml.Spreadsheet.Chartsheet> | A sheet that represents a chart that is stored as its own sheet. For more information, see [Working with sheets](working-with-sheets.md).  |
+| Table    |    `<table/>`    |     <xref:DocumentFormat.OpenXml.Spreadsheet.Table>  | A logical construct that specifies that a range of data belongs to a single dataset. For more information, see [Working with SpreadsheetML tables](overview.md).  |
+|Pivot Table       | `<pivotTableDefinition/>` |  <xref:DocumentFormat.OpenXml.Spreadsheet.PivotTableDefinition>  |  A logical construct that displays aggregated view of data in an understandable layout. For more information, see [Working with PivotTables](working-with-pivottables.md).  |
+|Pivot Cache  |   `<pivotCacheDefinition/>`  | <xref:DocumentFormat.OpenXml.Spreadsheet.PivotCacheDefinition> |  A construct that defines the source of the data in the PivotTable. For more information, see [Working with PivotTables](working-with-pivottables.md).  |
+|Pivot Cache Records |  `<pivotCacheRecords/>`  |  <xref:DocumentFormat.OpenXml.Spreadsheet.PivotCacheRecords>  |  A cache of the source data of the PivotTable. For more information, see [Working with PivotTables](working-with-pivottables.md). |
+| Calculation Chain | `<calcChain/>`  |  <xref:DocumentFormat.OpenXml.Spreadsheet.CalculationChain> | A construct that specifies the order in which cells in the workbook were last calculated. For more information, see [Working with the calculation chain](working-with-the-calculation-chain.md).  |
+|Shared String Table |  `<sst/>`  |  <xref:DocumentFormat.OpenXml.Spreadsheet.SharedStringTable>     | A construct that contains one occurrence of each unique string that occurs on all worksheets in a workbook. For more information, see [Working with the shared string table](working-with-the-shared-string-table.md). |
+|Conditional Formatting |   `<conditionalFormatting/>`   | <xref:DocumentFormat.OpenXml.Spreadsheet.ConditionalFormatting>  |  A construct that defines a format applied to a cell or series of cells. For more information, see [Working with conditional formatting](working-with-conditional-formatting.md).   |
+| Formulas  |      `<f/>`    |  <xref:DocumentFormat.OpenXml.Spreadsheet.CellFormula>  |  A construct that defines the formula text for a cell that contains a formula. For more information, see [Working with formulas](working-with-formulas.md).  |
 
 --------------------------------------------------------------------------------
 ## Minimum Workbook Scenario
@@ -74,10 +74,10 @@ This code example uses the classes in the Open XML SDK to create a
 minimum, blank workbook.
 
 ### [C#](#tab/cs)
-[!code-csharp[](../../samples/spreadsheet/structure_ofml/cs/Program.cs)]
+[!code-csharp[](../../samples/spreadsheet/structure_ofml/cs/Program.cs#snippet0)]
 
 ### [Visual Basic](#tab/vb)
-[!code-vb[](../../samples/spreadsheet/structure_ofml/vb/Program.vb)]
+[!code-vb[](../../samples/spreadsheet/structure_ofml/vb/Program.vb#snippet0)]
 
 ### Generated SpreadsheetML
 
@@ -95,11 +95,12 @@ Figure 1. .zip folder structure
 
 
  ![Structure of a minimum workbook](../media/odc_oxml_xl_documentstructure_fig02.gif)
-The **workbook.xml** file contains \<**sheet**\> elements that reference the worksheets in
+ 
+The **workbook.xml** file contains `<sheet/>` elements that reference the worksheets in
 the workbook. Each worksheet is associated to the workbook via a Sheet
-ID and a relationship ID. The **sheetID** is
+ID and a relationship ID. The `sheetID` is
 the ID used within the package to identify a sheet and must be unique
-within the workbook. The **id** is the
+within the workbook. The `id` is the
 relationship ID that identifies the sheet part definition associated
 with a sheet.
 
@@ -117,7 +118,7 @@ the Open XML SDK code to create a minimum workbook.
 ```
 
 The **workbook.xml.rels** file contains the
-\<**Relationship**\> elements that define the
+`<Relationship/>` elements that define the
 relationships between the workbook and the worksheets it contains.
 
 The following XML code is the spreadsheetML that represents the
@@ -131,9 +132,9 @@ when you run the Open XML SDK to create a minimum workbook.
     </Relationships>
 ```
 
-The **sheet.xml** file contains the \<**sheetData**\> element that represents the cell
-table. In this example, the workbook is blank, so the \<**sheetData**\> element is empty. For more
-information about sheets, see [Working with sheets](working-with-sheets.md)**.
+The **sheet.xml** file contains the `<sheetData/>` element that represents the cell
+table. In this example, the workbook is blank, so the `<sheetData/>` element is empty. For more
+information about sheets, see [Working with sheets](working-with-sheets.md).
 
 The following XML code is the spreadsheetML that represents the
 worksheet part of the spreadsheet document. This code is generated when
@@ -148,6 +149,7 @@ you run the Open XML SDK to create a minimum workbook.
 
 --------------------------------------------------------------------------------
 ## Typical Workbook Scenario
+
 A typical workbook will not be a blank, minimum workbook. A typical
 workbook might contain numbers, text, charts, tables, and pivot tables.
 Each of these additional parts is contained within the .zip package of

samples/spreadsheet/structure_ofml/cs/Program.cs

@@ -3,7 +3,7 @@
 using DocumentFormat.OpenXml.Spreadsheet;
 
 CreateSpreadsheetWorkbook(args[0]);
-
+// <Snippet0>
 static void CreateSpreadsheetWorkbook(string filepath)
 {
     // Create a spreadsheet document by supplying the filepath.
@@ -24,7 +24,6 @@ static void CreateSpreadsheetWorkbook(string filepath)
         // Append a new worksheet and associate it with the workbook.
         Sheet sheet = new Sheet() { Id = workbookPart.GetIdOfPart(worksheetPart), SheetId = 1, Name = "mySheet" };
         sheets.Append(sheet);
-
-        workbookPart.Workbook.Save();
     }
 }
+// </Snippet0>

samples/spreadsheet/structure_ofml/vb/Program.vb

@@ -2,38 +2,35 @@ Imports DocumentFormat.OpenXml
 Imports DocumentFormat.OpenXml.Packaging
 Imports DocumentFormat.OpenXml.Spreadsheet
 
-Module MyModule
-
+Module Program
     Sub Main(args As String())
-        Dim filepath As String = args(0)
-        CreateSpreadsheetWorkbook(filepath)
+        CreateSpreadsheetWorkbook(args(0))
     End Sub
 
-    Public Sub CreateSpreadsheetWorkbook(ByVal filepath As String)
+    ' <Snippet0>
+    Sub CreateSpreadsheetWorkbook(filepath As String)
         ' Create a spreadsheet document by supplying the filepath.
         ' By default, AutoSave = true, Editable = true, and Type = xlsx.
         Using spreadsheetDocument As SpreadsheetDocument = SpreadsheetDocument.Create(filepath, SpreadsheetDocumentType.Workbook)
-
             ' Add a WorkbookPart to the document.
-            Dim workbookpart As WorkbookPart = spreadsheetDocument.AddWorkbookPart
-            workbookpart.Workbook = New Workbook
+            Dim workbookPart As WorkbookPart = spreadsheetDocument.AddWorkbookPart()
+            workbookPart.Workbook = New Workbook()
 
             ' Add a WorksheetPart to the WorkbookPart.
-            Dim worksheetPart As WorksheetPart = workbookpart.AddNewPart(Of WorksheetPart)()
+            Dim worksheetPart As WorksheetPart = workbookPart.AddNewPart(Of WorksheetPart)()
             worksheetPart.Worksheet = New Worksheet(New SheetData())
 
             ' Add Sheets to the Workbook.
-            Dim sheets As Sheets = spreadsheetDocument.WorkbookPart.Workbook.AppendChild(Of Sheets)(New Sheets())
+            Dim sheets As Sheets = workbookPart.Workbook.AppendChild(Of Sheets)(New Sheets())
 
             ' Append a new worksheet and associate it with the workbook.
-            Dim sheet As Sheet = New Sheet
-            sheet.Id = spreadsheetDocument.WorkbookPart.GetIdOfPart(worksheetPart)
-            sheet.SheetId = 1
-            sheet.Name = "mySheet"
-
+            Dim sheet As Sheet = New Sheet() With {
+                .Id = workbookPart.GetIdOfPart(worksheetPart),
+                .SheetId = 1,
+                .Name = "mySheet"
+            }
             sheets.Append(sheet)
-
-            workbookpart.Workbook.Save()
         End Using
     End Sub
-End Module
+    ' </Snippet0>
+End Module