View Source

|| Table of Contents ||
| {toc:maxLevel=1} |


h1. Setting up the Template

h2. About templates and data markers

A PowerPointWriter *template* is a PowerPoint presentation that contains PowerPointWriter *data markers*. A *data marker* is a line of text beginning with {{%%=}} that specifies a database column, variable, or array to insert into the presentation.  PowerPointWriter supports data markers embedded in text. Data markers are added to a presentation in PowerPoint and then bound to data sources in code. PowerPointWriter populates the data markers with values from the data sources when the code is executed. {excerpt}Part 1 of this tutorial demonstrates how to use data markers to import single rows of data. 
{excerpt}  

h2. Data marker syntax

The basic syntax for a data marker is {{%%=\[DataSourceName\].\[ColumnName\]}}, where {{DataSourceName}} is the name of the data source and {{ColumnName}} is the name of the column in the data source. You need to follow these rules when naming data markers:

* Names must begin with a letter (A-Z, a-z)
** The following is a list of characters allowed in data marker names without brackets: ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz1234567890\_
* Names must exactly match the names in the data source.
** If a column in a database is 'Street Address', the {{ColumnName}} must be {{\[Street Address\]}} to account for the space. Similarly, if a data source name is "DataSource1", the data marker name must be {{DataSource1}} or {{\[DataSource1\]}}.

For more specific information about creating data markers, see [How to use Data Markers]

h2. Adding data markers to the the template

The template for Part 1 consists of 2 slides populated with text and data markers.

{info:title=Following the Sample Code} In the downloadable [PowerPointWriter_BasicTutorials.zip|http://wiki.softartisans.com/download/attachments/33226888/PowerPointWriter_BasicTutorials.zip] under _ProjectProposal_, there is a completed template file located in _ProjectProposal/templates/part1_template.pptx_.{info}

# Open Microsoft PowerPoint and start with a blank .pptx file.  Save the file as part1_template.pptx.  
\\ \# _(optional)_ Set the presentation theme by going to the Design tab and selecting one of the built-in themes.  
\\ \# A title slide should have been added to the presentation by default. If not, then insert a title slide now. 
\\ These will hold our data markers for the title, date and review status of the proposed product.  
\\ \\ 
# Populate the title textbox with the data marker {{%%=Proposal.Name}}.  When the template is processed, this data marker will get the value from the 'Name' column in the 'Proposal' data source.
\\ \\ !SlideOne.png|border=1!
\\ \# In the subtitle box, add {{%%=Proposal.Date}}. 
\\ \# Insert a new textbox and place in near the bottom of the slide. This will hold the review status of the project. Type {{%%=Proposal.ReviewStatus}} into the box. Format with desired font size and formatting. 
\\The final slide should look something like the one below.
\\ \!SlideOneFinal.png|border=1!
\\ \# Insert a new content slide.  This slide should consist of two text boxes: one for the title and a large one for the body of text.  
\\ \\ 
# In the title text box, place the data marker %%=Proposal.Name.  Note that this is the same as the data marker used on our first slide, and will be populated with the same data.  
\\ \# In the large text box add the following text to a list:
- Leader: %%=Proposal.Leader
- Start Date: %%=Proposal.Start
- Estimated time to completion: %%=Proposal.Estimate 
- Description: %%= Proposal.Summary

These will contain additional data about our project.  PowerPointWriter supports data markers embedded in text, so only one text box is needed for all of our data markers.

The finished slide should look like the one below.

!SlideTwoFinal.png|border=1!


h1. Adding a PowerPointWriter Reference in Visual Studio

{info:title=Following the Sample Code} In the sample code, the reference to _SoftArtisans.OfficeWriter.PowerPointWriter.dll_ has already been added to the _ProjectProposal_ project.{info}

Create a .NET project and add a reference to the PowerPointWriter library.

# Open Visual Studio and create a .NET project.
#* The sample code uses a web application.
# Add a reference to SoftArtisans.OfficeWriter.PowerPointWriter.dll
#* SoftArtisans.OfficeWriter.PowerPointWriter.dll is located under *Program Files > SoftArtisans > OfficeWriter > dotnet > bin*

h1. Writing the Code

{info:title=Following the Sample Code} There is a sample web application page {{Part1.aspx}} and code behind {{Part1.aspx.cs}} available in the _ProjectProposal/templates/part1_template.pptx_ directory that shows the completed code.{info}

# Include the SoftArtisans.OfficeWriter.PowerPointWriter namespace in the code behind
\\ \{newcode}
using SoftArtisans.OfficeWriter.PowerPointWriter;
{newcode}
\\ \# In the method that will actually create the presentation, instantiate the {{[PowerPointTemplate]}} object.
\\ \{newcode}
PowerPointTemplate pptt = new PowerPointTemplate();
{newcode}
\\ \# Open the template file for the presentation.
{newcode}
pptt.Open(Page.MapPath("//templates//part1_template.pptx"));
{newcode}
\\ \# Create a DatabindingProperties object for binding data to the template.
{newcode}
DataBindingProperties dataProps = pptt.CreateDataBindingProperties();
{newcode}
\\ \# Create an array to hold the values that will appear in the presentation.  
\\ \{newcode}
//The values to display
//This presentation is for a project proposal for a surgery scheduling software
object[] valuesArray = { "Surgery Schedule", "January 1, 2014", "Under Review", "Pamela Blythe", "January 1, 2015", "6 months", "Software to schedule surgeries that require multiple resources such as surgeons, assistants, nurses, pre-op and post-op space, surgery theater, long-term recovery rooms." };
{newcode}
\\ \# Create a second array that contains the column names.  The column names values must match the data markers in the template.
{newcode}
//The column names are the same as the data markers
string[] columnNamesArray = { "Name", "Date", "ReviewStatus", "Leader", "Start", "Estimate", "Summary" };
{newcode}
\\ \# Bind the data to the template.  Make sure the data source name is the same as the name used in the template.
{newcode}
pptt.BindData(valuesArray, columnNamesArray, "Proposal", dataProps);
{newcode}
\\ \# Call process to import the data into the template and save the file.
{newcode}
pptt.Process();

//Stream the output in the response as an attachment
pptt.Save(Page.Response, "Part1_Output.xlsx", false);
{newcode}

h1. Final Code
{newcode}
PowerPointTemplate pptt = new PowerPointTemplate();
pptt.Open(Page.MapPath("//templates//part1_template.pptx"));
DataBindingProperties dataProps = pptt.CreateDataBindingProperties();
object[] valuesArray = { "Surgery Schedule", "January 1, 2014", "Under Review", "Pamela Blythe", "January 1, 2015", "6 months", "Software to schedule surgeries that require multiple resources such as surgeons, assistants, nurses, pre-op and post-op space, surgery theater, long-term recovery rooms." };
string[] columnNamesArray = { "Name", "Date", "ReviewStatus", "Leader", "Start", "Estimate", "Summary" };
pptt.BindData(valuesArray, columnNamesArray, "Proposal", dataProps);
pptt.Process();
pptt.Save(Page.Response, "Part1_Output.xlsx", false)
{newcode}

h1. Downloads
You can download the code for the Basic PowerPointWriter Tutorials as a Visual Studio solution, which includes the Project Proposal.

* [PowerPointWriter_BasicTutorials.zip|Tutorials^PowerPointWriter_BasicTutorials.zip]

h1. Next Steps

[Continue on to Part 2 - Repeat Behavior and Delete Slide | Part 2 - Repeat Behavior]