package izyndoc;

import com.jacob.com.*;

/**
 * <p>Title: WordDocuments</p>
 * <p>Description: </p>
 * <p>Copyright: Copyright (c) 2004</p>
 * <p>Company: Izyn Technologies</p>
 * @author Richard Norton
 * orignal framework sourced from
 * http://forum.java.sun.com/thread.jsp?forum=40&thread=215469&tstart=135&trange=15
 * @version 1.0
 */

public class WordDocuments extends com.jacob.com.Dispatch
{
  /**
   * Constructor.
   */
  public WordDocuments()
  {
    super();
  }

  /**
   * Alternative constructor to be used if you need to return a Documents
   * object from another object's method call.
   *
   * @param dispatchDocuments Dispatch
   */
  public WordDocuments(Dispatch dispatchDocuments)
  {
    //TAKE OVER IDispatch POINTER
    m_pDispatch = dispatchDocuments.m_pDispatch;
    //NULL OUT THE INPUT'S POINTER
    dispatchDocuments.m_pDispatch = 0;
  }

  /**
   * Open a document.
   *
   * @param documentFilename String
   * @return WordDocuments
   */
  public WordDocuments open(String documentFilename)
  {
    return new WordDocuments(Dispatch.call(this, "Open"
        , new Variant(documentFilename)).toDispatch());
  }

  /**
   * Add a document to the documents collection.
   *
   * @param templateFilename String
   * @return WordDocument
   */
  public WordDocument addDoc(String templateFilename)
  {
    return new WordDocument(Dispatch.call(this, "Add"
        , new Variant(templateFilename)).toDispatch());
  }

  /**
   * Add a copy of a template to the documents collection.
   *
   * @param templateFilename String
   * @return WordDocument
   */
  public WordDocument addTemp(String templateFilename)
  {
    return new WordDocument(Dispatch.call(this, "Add"
        , new Variant(templateFilename), new Variant(Word.TRUE)).toDispatch());
  }
}