Due to a change in the later versions of Professional some of you may have to comment out this line.

' Link into the mrStudio Output window
set objSurveyCraft.mrStudioLog = Debug

This issue has been reported to SPSS.

First off we will deal with creating the space for the answers so make sure that you have your main code setup like this so that we can create a new template file.

' These two lines will make a template for us.
oWord.Documents.Add()
RunTemplate(oWord,IOM,False)
' These lines will use a template and show results
'oWord.Documents.Open("c:\temp\TemplateGrids.docx")
'RunTemplate(oWord,IOM,True)
 First off we are going to add the following formatting functions
Sub AddGridSplitRowToTable(oWord,sLabel,sAnswerLabel,sAnswer,iRows,iCols)
    oWord.Selection.MoveRight(12)
    oWord.Selection.Cells.Split(iRows,iCols,True)
    oWord.Selection.Text = sAnswerLabel
    oWord.Selection.MoveRight(12)
    oWord.Selection.Text = sAnswer
End Sub

Sub AddGridRowToTable(oWord,sAnswer)
    oWord.Selection.MoveRight(12)
    oWord.Selection.Text = sAnswer
End Sub
Sub AddNextGridRowToTable(oWord,sLabel,sAnswer)
   oWord.Selection.MoveRight(12)
    oWord.Selection.Text = sLabel
    oWord.Selection.MoveRight(12)
    oWord.Selection.Text = sAnswer
End Sub

These functions are similar to the other formatting ones, but they have, in places a few other pieces of code to make a more complex word table to house the grid question.

Next we need to look at the RunTemplate subroutine and expand the case statement to look like this,

For Each oQuestion in IOM.Questions
 Select Case oQuestion.QuestionType
 Case QuestionTypes.qtSimple
  If ( bWithAnswers ) Then
   GetAnswers(oQuestion,"S","",oWord)
  Else
   MakeSpace(oWord)
   MakeTable(oWord,oQuestion.Label)
        CreateQuestions(oQuestion,"S","",oWord,0,IOM)
        End If
        Case QuestionTypes.qtLoopCategorical, QuestionTypes.qtLoopNumeric
         If ( bWithAnswers ) Then
   GetAnswers(oQuestion,"G","",oWord)
  Else
        MakeSpace(oWord)
   MakeTable(oWord,oQuestion.Label)
   CreateQuestions(oQuestion,"G","",oWord,0,IOM)
  End If
        Case QuestionTypes.qtBlock, QuestionTypes.qtCompound, QuestionTypes.qtPage
         If ( bWithAnswers ) Then
   GetAnswers(oQuestion,"G","",oWord)
  Else
               MakeSpace(oWord)
   MakeTable(oWord,oQuestion.Label)
   CreateQuestions(oQuestion,"G","",oWord,0,IOM)
  End If
    End Select
Next

Again there is nothing really new here , the main thing is that we are passing in the letter “G” to the createQuestions subroutine so that we can identify simply that we are passing it a grid question. So now let’s look at CreateQuestions,

  Case = "GS"
   'MakeTable(oWord,oQuestion.Label)
     Select Case oQuestion.QuestionDataType
      Case = DataTypeConstants.mtDate
      Case = DataTypeConstants.mtBoolean,DataTypeConstants.mtDouble, _
             DataTypeConstants.mtLong,DataTypeConstants.mtText
      Case Else
       iCat = 0
       For each oCat in oQuestion.Categories
        If iCat = 0 Then
       If ( iQCount = 2 ) Then
             If ( sLabel = "" ) Then
              AddGridSplitRowToTable(oWord,oQuestion.Label,oCat.Label,"X" + _
              oQuestion.QuestionFullName + ":" + _
           oCat.Name + "X",1,oQuestion.Categories.count+1)
        Else
         AddGridSplitRowToTable(oWord,sLabel, oIOM.Questions[oQuestion.ParentQuestion.ParentQuestion.QuestionName].categories[oQuestion.ParentQuestion.QuestionName].label,"X" + _
        oQuestion.QuestionFullName + ":" + _
                 oCat.Name + "X",1,oQuestion.Categories.count+1)
        End If
       Else
        'At This stage I need to know
        'oIOM.Questions["GridQuestion"].categories["Sub1"].label
       If ( sLabel = "" ) Then
              AddNextGridRowToTable(oWord,oIOM.Questions[oQuestion.ParentQuestion.ParentQuestion.QuestionName].categories[oQuestion.ParentQuestion.QuestionName].label,"X" + oQuestion.QuestionFullName + ":" + _
           oCat.Name + "X")
        Else
         AddNextGridRowToTable(oWord,oIOM.Questions[oQuestion.ParentQuestion.ParentQuestion.QuestionName].categories[oQuestion.ParentQuestion.QuestionName].label,"X" + oQuestion.QuestionFullName + ":" + _
                 oCat.Name + "X")
        End If
       End If
      Else
            If ( sLabel = "" ) Then
             AddGridRowToTable(oWord,"X" + oQuestion.QuestionFullName + ":" + _
          oCat.Name + "X")
       Else
        AddGridRowToTable(oWord,"X" + oQuestion.QuestionFullName + ":" + _
                oCat.Name + "X")
       End If
      End If
      iCat = iCat + 1
          Next

          ' Do we have Other Responses
          For Each oOther in oQuestion.OtherCategories
           If ( sLabel = "" ) Then
            AddSimpleTable(oWord,oQuestion.Label,oOther.Label,"X" + _
            oQuestion.QuestionFullName + ":" + _
         oOther.Name + ":OtherTextX")
      Else
       AddSimpleTable(oWord,sLabel,oOther.Label,"X" + _
             oQuestion.QuestionFullName + ":" + _
               oOther.Name + ":OtherTextX")
      End If
           Next
     End Select
     Case = "G"
          For each oItem in oQuestion
      iQCount = iQCount + 1
   If ( Find(oItem.ParentQuestion.QuestionFullname,"{") > -1 ) Then
           CreateQuestions(oItem,"GS",oQuestion.ParentQuestion.Label,oWord,iQCount,oIOM)
         Else
           CreateQuestions(oItem,"G",oQuestion.Label,oWord,iQCount,oIOM)
      End If
      Next

This code is added to the main Select case statement in the function and deals with two additional cases “GS” and “G”. Looking at the “G” case first , what we do is , it if it is a grid style question we loop round each sub question. At this stage the code has only be used on a simple grid question so there may be other code that we have to put in place , but this is enough now to get going with. What happens is that a check is made on the child question and if it is the true child then we call the CreateQuestions function again but this time pass in the letters “GS” or GridSimple, otherwise we pass in “G”

When it comes to the “GS” case what is really happening here is that we are doing exactly the same as the “S” case , but because we are a grid we are using different functions. Some of you might say that we should really just modify the “S” code to cope with grid simple questions and we will , when we have sorted out all the bugs etc. It’s easier to have two cases to start with until we have designed everything. This would be V1 of the script. Version 2 would be the more streamlined and faster version with less code.

Next we need to look at the getansewrs, all we  need to do is to add a select case that deals with the grid style questions.

Case = "G"
   For each oItem in oQuestion
    If ( Find(oItem.ParentQuestion.QuestionFullname,"{") > -1 ) Then
        GetAnswers(oItem,"S",oQuestion.ParentQuestion.Label,oWord)
       Else
        GetAnswers(oItem,"G",oQuestion.Label,oWord)
 End If
    Next

This code is straight forward. We loop all the questions in the grid, and if they are a child then we run the getAnswers function , passing in the Parent Label and if they are a complex question we pass in the complex question label.

And there you have it , when you run the code now , you will , if everything is setup correctly end up with a template file that looks like this for the grid questions.

Template With Grids 2 pages

as you can see we have the grid split across the pages and the cell contents is larger than it needs to be. To adress this we add some code to change the font size of the cell contents ,

Sub AddGridSplitRowToTable(oWord,sLabel,sAnswerLabel,sAnswer,iRows,iCols)

    oWord.Selection.MoveRight(12)
    oWord.Selection.Cells.Split(iRows,iCols,True)
    oWord.Selection.Text = sAnswerLabel
    oWord.Selection.MoveRight(12)
    oWord.Selection.Font.Size = 2
    oWord.Selection.Text = sAnswer

End Sub

Sub AddGridRowToTable(oWord,sAnswer)

    oWord.Selection.MoveRight(12)
    oWord.Selection.Font.Size = 2
    oWord.Selection.Text = sAnswer

End Sub

Sub AddNextGridRowToTable(oWord,sLabel,sAnswer)

    oWord.Selection.MoveRight(12)
    oWord.Selection.Text = sLabel

    oWord.Selection.MoveRight(12)
    oWord.Selection.Font.Size = 2
    oWord.Selection.Text = sAnswer

End Sub

so when we re run the script it ends up looking like this,

Template With Grids

This will be more relasitic to the formating of the document. Next add the look and feel to the template file and then re-run the script to place the respondent answers in and you will end up with something like this,

Template With Answers

And there you have it, version one of our Print to word code. In version two we will try and come up with some methods to get the logic out displayed in the document.

The full version One code can be found in the smarter dimensions code corner.

Basic Layout

What you can do , is format this template file even further , for example add you own logos and page formatting. The key thing is that you do not remove the place holders that will be used to place the respondents answers in. And to be honest that is all we care about at this stage , you can change / move what you like , just don’t mess with the place holders. So what you could end up with is a template file for you survey like this,  

Fornatted Template

So once we have format the document the way we want then we can start to add the code to get the answers in. Currently your script will be saying this ,

 ' These two lines will make a template for us.
oWord.Documents.Add()
RunTemplate(oWord,IOM,False)
' These lines will use a template and show results
'oWord.Documents.Open("D:\DATA\SD\Library\PrintToWord\TemplateGrids.docx")
'RunTemplate(oWord,IOM,True)

What we want to do now is to flip this around. We have our template all nicely formatted , we now want to use it. Change the above 6 lines of code to this, 

' These two lines will make a template for us.
'oWord.Documents.Add()
'RunTemplate(oWord,IOM,False)
' These lines will use a template and show results
oWord.Documents.Open("c:\temp\Template.docx")
RunTemplate(oWord,IOM,True)

We are also going to uncomment the get answers line in our RunTemplate subroutine, 

 If ( bWithAnswers ) Then
 GetAnswers(oQuestion,"S","",oWord)
Else
 MakeSpace(oWord)
 MakeTable(oWord,oQuestion.Label)
 CreateQuestions(oQuestion,"S","",oWord,0,IOM)
End If

You will have noticed by now that when we call the RunTemplate subroutine this time we are passing in a True value , which tells us that we are looking for answers. To get the answers we need to have a GetAnswer function and this function looks like this, 

 Sub GetAnswers(oQuestion,sType,sLabel,oWord)
Dim oCat,oItem,oOther
 Select Case sType
  Case = "S"
     Select Case oQuestion.QuestionDataType
      Case = DataTypeConstants.mtDate
              FindAnswer(oWord,"X" + oQuestion.QuestionFullName + _
                            "X",oQuestion.Response.Value)
      Case = DataTypeConstants.mtBoolean,DataTypeConstants.mtDouble, _
             DataTypeConstants.mtLong,DataTypeConstants.mtText
      FindAnswer(oWord,"X" + oQuestion.QuestionFullName + _
                            "X",oQuestion.Response.Value)
      Case Else
       For each oCat in oQuestion.Categories
        If ( oCat.Value.Format("a") = oQuestion.Response.Value.Format("a") ) Then
             FindAnswer(oWord,"X" + oQuestion.QuestionFullName + ":" + _
        oCat.Name + "X","Yes")
       Else
            FindAnswer(oWord,"X" + oQuestion.QuestionFullName + ":" + _
        oCat.Name + "X","No")
      End If
           Next
          ' Do we have Other Responses
          For Each oOther in oQuestion.OtherCategories
           FindAnswer(oWord,"X" + oQuestion.QuestionFullName + ":" + _
    oCat.Name + ":OtherTextX",oOTher.OtherQuestion.response.value)
          Next
     End Select
     Case = "G"
  ' Grid code to go here
 End Select
End Sub

As before at this stage we are only looking at simple questions , so when we get one inside this subroutine we again check its real data type. At this stage we have split date times from boolean, double , long and text, but in reality they could be the same. If we can we would like to get some sort of calendar control showed in the document to show dates just to show you what is possible, but that will come in later articles.

 When it comes to the categorical we loop each category and check each one in turn. If the category we are on is the same as the data value entered by the respondent then we pass in a “Yes” as the answer to the findAnswer subroutine and if it is not a match we pass in a NO. Once this is done with the categories we do the same with the other specify if there are any, but of course , we don’t pass in a yes , we pass in the text.

 So what does Find answer look like and do.

 Sub FindAnswer(oWord,sLookingFor,sValue)
         With oWord.Selection.Find
           .Text = sLookingFor
           .Replacement.Text = sValue
           .Forward = True
           .Format = False
           .MatchCase = False
           .MatchWholeWord = False
           .MatchWildcards = False
           .MatchSoundsLike = False
           .MatchAllWordForms = False
         End With
         oWord.Selection.Find.Execute(,,,,,,,,,,1,,,,)
         oWord.Selection.Font.Size = 10
         oWord.Selection.HomeKey(6)
End Sub

�
When we call findanswer we pass in the word document, the thing we are looking for and what we want to replace it with so because we have a template in place with our markers we can use the word find option, when we have found the marker we are looking for we replace it with the contents we need , set its font size to be ten, and then move back up the top of the document again ready for the next find.
�
And there you have it , if you get all this working you will end up with code that will loop all your simple answers and place the responses in the template in the correct location. For us , because we formatted our template , our document looked like this in the end.

Template with answers

In our next article we will start to add the code that will handle the complex question types.