Text Object Model and C++ -- General HowTo

Question

Text Object Model and C++ -- General HowTo

Andre LeBlanc 21

Hi There, how would I accomplish separating actions with functions e.g. render a line of text or table from one function; then later on a different function that will just write text or whatever. I have tried sending an ITextRange2* as a parameter and then using that pointer in the other function. I guess I need an explanation on how to start and end ranges ... Below is what I'm trying to do - thank you in advance for your help:
HRESULT CMHMView::AddDocumentInfo(ITextRange2* pRange, long& lDelta)
{
CRichEditCtrl& rCtrl = GetRichEditCtrl();
rCtrl.SetSel(0, -1);
rCtrl.Clear();

    float unitprice = 0.0f;
    CString priceDisplay;
    CString sDescription;

    CString sCustomerAddress = L"";
    CString sOfficeAddress = L"";

    HRESULT hr = S_FALSE;

    CComPtr<ITextRange2> ptr2;
    CComPtr<ITextFont> pFont;

    hr = pRange->GetFont(&pFont);

    if (pFont && ptr2)
    {
        CComPtr<ITextRow> pRow;
        CComPtr<ITextFont> pFontDuplicate;

        hr = pRange->GetRow(&pRow);
        hr = pFont->GetDuplicate(&pFontDuplicate);

        if (pRow && pFontDuplicate)
        {
            CComPtr<ITextPara> pPara, pParaDuplicate;

            long lStart{}, lEnd{};
            // Font
            hr = pFontDuplicate->SetName(CComBSTR(L"Courier New"));
            hr = pFontDuplicate->SetSize(12.0f);
            //Paragraph
            hr = pRange->GetPara(&pPara);
            hr = pPara->GetDuplicate(&pParaDuplicate);

            // Customer and Office Address Table (1x3)
            hr = pRow->SetCellCount(3);
            hr = pRow->SetCellIndex(0);
            hr = pRow->SetCellWidth(3600);
            hr = pRow->Insert(1);

            hr = ptr2->SetIndex(tomTable, 1, 0);
            hr = ptr2->SetText(CComBSTR(sCustomerAddress));
            hr = pParaDuplicate->SetAlignment(tomAlignLeft);
            hr = ptr2->SetFont(pFontDuplicate);
            hr = ptr2->SetPara(pParaDuplicate);
            hr = ptr2->MoveStart(tomCell, 2, &lDelta);
            hr = ptr2->SetText(CComBSTR(sOfficeAddress));

            hr = pParaDuplicate->SetAlignment(tomAlignRight);
            hr = pRange->SetFont(pFontDuplicate);
            hr = pRange->SetPara(pParaDuplicate);

            hr = pRange->EndOf(tomTable, tomMove, &lDelta);

            hr = pRange->SetText(CComBSTR(L"\n\nWe are pleased to submit our proposal for the following:\n\n"));

            hr = pRange->SetFont(pFontDuplicate);
            hr = pRange->Collapse(tomEnd);
            hr = pRange->Select();
            hr = pRange->GetEnd(&m_lEnd);
        }
    }

    return hr;
}

And the function that would call the above:

void CMHMView::AddPartsTable()
{
ITextDocument2* ptd2 = NULL;
    CRichEditCtrl& re = GetRichEditCtrl();
    IRichEditOle* pRichOle = re.GetIRichEditOle();
    HRESULT hr = pRichOle->QueryInterface(IID_PPV_ARGS(&ptd2));

    if (SUCCEEDED(hr))
    {
        CComPtr<ITextRange2> ptr2;
        CComPtr<ITextFont> pFont, pFont2;

        hr = ptd2->Range2(0, 0, &ptr2);
        hr = ptr2->GetFont(&pFont);
        hr = ptr2->GetFont(&pFont2);

        if (pFont && ptr2)
        {
            CComPtr<ITextRow> pRow, pRow2;
            CComPtr<ITextFont> pFontDuplicate, pFontDuplicate2;

            hr = ptr2->GetRow(&pRow);
            hr = pFont->GetDuplicate(&pFontDuplicate);

            if (pRow && pFontDuplicate)
            {
                CComPtr<ITextPara> pPara, pParaDuplicate;
                long lDelta{};
                long lStart{}, lEnd{};
                // Font
                hr = pFontDuplicate->SetName(CComBSTR(L"Courier New"));
                hr = pFontDuplicate->SetSize(12.0f);
                //Paragraph
                hr = ptr2->GetPara(&pPara);
                hr = pPara->GetDuplicate(&pParaDuplicate);

                               hr = AddDocumentInfo(ptr2, lDelta);

                               // Additional processing below //
                       }
        }       
    }
    pRichOle->Release();
}

RLWA32 49,536 Reputation points

2022-03-09T15:40:06.94+00:00

Briefly explain what you are trying to accomplish (in words, not code). You should also take another look at the posted code -- it contains some errors.
Andre LeBlanc 21 Reputation points

2022-03-09T15:58:17.087+00:00

Ok; please point out the errors :-) Based on user interaction the document will continue "flowing" from the last point. So, I thought I was clear. Let's say I have two functions, and to keep it simple, the first function will write text - "This is text 1". The second function will write "This is text 2". So I initialize all the interfaces required for function1 in its body. The question is what interface pointer do I pass to function2, or do I have a parameterless function2 and redefine the same objects?
Andre LeBlanc 21 Reputation points

2022-03-09T16:19:06.02+00:00

The user will open up a dialog to search for a part to continue adding to the table as shown in the picture.
RLWA32 49,536 Reputation points

2022-03-09T16:24:08.617+00:00
Coding items -

AddPartsTable() - Interface leak on ITexDocument2 -- smart pointer not used.

AddDocumentInfo() - Code not executed, ptr2 not initialized so if(pFont && ptr2) is always FALSE. Why use another ITextRange2 interface pointer (ptr2) when one is passed into the function (pRange)? And varialbe m_lLend is not defined.

If you want to continue adding content to a document why not just position the ITextRange2 to the end of the prior section and then pass that to the function that adds additional content? Have you tried initializing other characteristics like font, paragraph attributes, etc. once and then passing those interface pointers to the functions that add additional content?
Andre LeBlanc 21 Reputation points

2022-03-09T16:32:52.937+00:00

That's spot on what I want. How do you posiition the range to the end (GetEnd method?)and the beginning (SetStart method?) of another using the same? Can you just give me a simple example? Thank so much!
Andre LeBlanc 21 Reputation points

2022-03-09T22:09:55.737+00:00

Never mind I figured it out ... I wish I had better descriptions of what each method does along with an example.
RLWA32 49,536 Reputation points

2022-03-10T01:08:47.86+00:00

Glad to hear that you've got it sorted out. You might consider sharing what you did here for the benefit of anyone else brave enough to try working with TOM.
Andre LeBlanc 21 Reputation points

2022-03-10T15:06:07.79+00:00
Sure thing ... please correct my errors when/if you see them :-) Below is a class function that I use to add a new table or continue adding rows to existing table. Member variables are doneted with "**m_**xxxxxxx" and initialized in my derived CRichEditView::OnItinialUpdate virtual function as:

CRichEditCtrl& re = GetRichEditCtrl(); m_pREOle = re.GetIRichEditOle(); m_hr = m_pREOle->QueryInterface(IID_PPV_ARGS(&m_ptd2));

Andre LeBlanc 21

And this is the method that I will be using for my purposes:

void CMHMView::InsertTableRow(long index, long& start, long& end, long ncells, 
    long cellwidths[], long skip, LPCTSTR* sText, BOOL bAppend)
{

    if (SUCCEEDED(m_hr))
    {
        long lDelta{};

        CComPtr<ITextFont> pFont;

        m_hr = m_ptr2->GetFont(&pFont);

        CComPtr<ITextRow> pRow;
        CComPtr<ITextFont> pFontDuplicate;

        m_hr = m_ptr2->GetRow(&pRow);
        m_hr = pFont->GetDuplicate(&pFontDuplicate);

        if (pRow && pFontDuplicate)
        {
            CComPtr<ITextPara> pPara, pParaDuplicate;
            m_hr = m_ptr2->GetPara(&pPara);
            m_hr = pPara->GetDuplicate(&pParaDuplicate);

            m_hr = pFontDuplicate->SetName(CComBSTR(L"Courier New"));
            m_hr = pFontDuplicate->SetSize(12.0f);

            m_hr = m_ptr2->MoveStart(tomTable, start, &lDelta);
            m_hr = m_ptr2->Collapse(tomEnd);

Andre LeBlanc 21

if (bAppend)
{
m_hr = pRow->SetCellCount(ncells);
for (int i = 0; i < ncells; i++)
{
m_hr = pRow->SetCellIndex(i);
m_hr = pRow->SetCellWidth(cellwidths[i]);
}

                m_hr = pRow->Insert(1);
                m_hr = m_ptr2->SetIndex(tomTable, index, 0);

                for (int i = 0; i < skip; i++)
                {
                    if (i > 0)
                        m_hr = m_ptr2->MoveStart(tomCell, 1, &lDelta);
                    m_hr = m_ptr2->SetText(CComBSTR(L""));
                }
                for (int i = 0; i < ncells; i++)
                {
                    if (i > 0)
                        m_hr = m_ptr2->MoveStart(tomCell, 1, &lDelta);

                    m_hr = m_ptr2->SetText(CComBSTR(sText[i]));
                    m_hr = m_ptr2->SetFont(pFontDuplicate);
                    m_hr = m_ptr2->SetPara(pParaDuplicate);

                }

                m_hr = m_ptr2->EndOf(tomTable, tomMove, &lDelta);


                m_hr = m_ptr2->GetEnd(&end);
            }

Andre LeBlanc 21

else
{
m_hr = m_ptr2->SetText(CComBSTR(L"\r"));
m_hr = m_ptr2->Collapse(tomEnd);

                m_hr = pRow->SetCellCount(ncells);
                for (int i = 0; i < ncells; i++)
                {
                    m_hr = pRow->SetCellIndex(i);
                    m_hr = pRow->SetCellWidth(cellwidths[i]);
                    /*pRow->SetCellMergeFlags(tomHStartCell)*/
                }

                m_hr = pRow->Insert(1);
                m_hr = m_ptr2->SetIndex(tomTable, index, 0);

                for (int i = 0; i < ncells; i++)
                {
                    if (i > 0)
                        m_hr = m_ptr2->MoveStart(tomCell, 1, &lDelta);

                    m_hr = m_ptr2->SetText(CComBSTR(sText[i]));
                    m_hr = m_ptr2->SetFont(pFontDuplicate);
                    m_hr = m_ptr2->SetPara(pParaDuplicate);

                }

                m_hr = m_ptr2->EndOf(tomTable, tomMove, &lDelta);
                m_hr = m_ptr2->GetEnd(&end);

            }
        }
    }
    m_pREOle->Release();
}

Thank you RLWA32-6355 for all your help - it would never have been possible without!!

1 answer

Your answer

RLWA32 49,536 Reputation points

2022-03-09T15:40:06.94+00:00

Briefly explain what you are trying to accomplish (in words, not code). You should also take another look at the posted code -- it contains some errors.
Andre LeBlanc 21 Reputation points

2022-03-09T15:58:17.087+00:00

Ok; please point out the errors :-) Based on user interaction the document will continue "flowing" from the last point. So, I thought I was clear. Let's say I have two functions, and to keep it simple, the first function will write text - "This is text 1". The second function will write "This is text 2". So I initialize all the interfaces required for function1 in its body. The question is what interface pointer do I pass to function2, or do I have a parameterless function2 and redefine the same objects?
Andre LeBlanc 21 Reputation points

2022-03-09T16:19:06.02+00:00

The user will open up a dialog to search for a part to continue adding to the table as shown in the picture.
RLWA32 49,536 Reputation points

2022-03-09T16:24:08.617+00:00

Coding items -

AddPartsTable() - Interface leak on ITexDocument2 -- smart pointer not used.

AddDocumentInfo() - Code not executed, ptr2 not initialized so if(pFont && ptr2) is always FALSE. Why use another ITextRange2 interface pointer (ptr2) when one is passed into the function (pRange)? And varialbe m_lLend is not defined.

If you want to continue adding content to a document why not just position the ITextRange2 to the end of the prior section and then pass that to the function that adds additional content? Have you tried initializing other characteristics like font, paragraph attributes, etc. once and then passing those interface pointers to the functions that add additional content?
Andre LeBlanc 21 Reputation points

2022-03-09T16:32:52.937+00:00

That's spot on what I want. How do you posiition the range to the end (GetEnd method?)and the beginning (SetStart method?) of another using the same? Can you just give me a simple example? Thank so much!
Andre LeBlanc 21 Reputation points

2022-03-09T22:09:55.737+00:00

Never mind I figured it out ... I wish I had better descriptions of what each method does along with an example.
RLWA32 49,536 Reputation points

2022-03-10T01:08:47.86+00:00

Glad to hear that you've got it sorted out. You might consider sharing what you did here for the benefit of anyone else brave enough to try working with TOM.
Andre LeBlanc 21 Reputation points

2022-03-10T15:06:07.79+00:00

Sure thing ... please correct my errors when/if you see them :-) Below is a class function that I use to add a new table or continue adding rows to existing table. Member variables are doneted with "**m_**xxxxxxx" and initialized in my derived CRichEditView::OnItinialUpdate virtual function as:

CRichEditCtrl& re = GetRichEditCtrl(); m_pREOle = re.GetIRichEditOle(); m_hr = m_pREOle->QueryInterface(IID_PPV_ARGS(&m_ptd2));
Andre LeBlanc 21 Reputation points

2022-03-10T15:07:13.427+00:00

And this is the method that I will be using for my purposes:

void CMHMView::InsertTableRow(long index, long& start, long& end, long ncells, long cellwidths[], long skip, LPCTSTR* sText, BOOL bAppend) { if (SUCCEEDED(m_hr)) { long lDelta{}; CComPtr<ITextFont> pFont; m_hr = m_ptr2->GetFont(&pFont); CComPtr<ITextRow> pRow; CComPtr<ITextFont> pFontDuplicate; m_hr = m_ptr2->GetRow(&pRow); m_hr = pFont->GetDuplicate(&pFontDuplicate); if (pRow && pFontDuplicate) { CComPtr<ITextPara> pPara, pParaDuplicate; m_hr = m_ptr2->GetPara(&pPara); m_hr = pPara->GetDuplicate(&pParaDuplicate); m_hr = pFontDuplicate->SetName(CComBSTR(L"Courier New")); m_hr = pFontDuplicate->SetSize(12.0f); m_hr = m_ptr2->MoveStart(tomTable, start, &lDelta); m_hr = m_ptr2->Collapse(tomEnd);
Andre LeBlanc 21 Reputation points

2022-03-10T15:07:44.563+00:00

if (bAppend)
{
m_hr = pRow->SetCellCount(ncells);
for (int i = 0; i < ncells; i++)
{
m_hr = pRow->SetCellIndex(i);
m_hr = pRow->SetCellWidth(cellwidths[i]);
}

m_hr = pRow->Insert(1); m_hr = m_ptr2->SetIndex(tomTable, index, 0); for (int i = 0; i < skip; i++) { if (i > 0) m_hr = m_ptr2->MoveStart(tomCell, 1, &lDelta); m_hr = m_ptr2->SetText(CComBSTR(L"")); } for (int i = 0; i < ncells; i++) { if (i > 0) m_hr = m_ptr2->MoveStart(tomCell, 1, &lDelta); m_hr = m_ptr2->SetText(CComBSTR(sText[i])); m_hr = m_ptr2->SetFont(pFontDuplicate); m_hr = m_ptr2->SetPara(pParaDuplicate); } m_hr = m_ptr2->EndOf(tomTable, tomMove, &lDelta); m_hr = m_ptr2->GetEnd(&end); }
Andre LeBlanc 21 Reputation points

2022-03-10T15:08:00.507+00:00

else
{
m_hr = m_ptr2->SetText(CComBSTR(L"\r"));
m_hr = m_ptr2->Collapse(tomEnd);

m_hr = pRow->SetCellCount(ncells); for (int i = 0; i < ncells; i++) { m_hr = pRow->SetCellIndex(i); m_hr = pRow->SetCellWidth(cellwidths[i]); /*pRow->SetCellMergeFlags(tomHStartCell)*/ } m_hr = pRow->Insert(1); m_hr = m_ptr2->SetIndex(tomTable, index, 0); for (int i = 0; i < ncells; i++) { if (i > 0) m_hr = m_ptr2->MoveStart(tomCell, 1, &lDelta); m_hr = m_ptr2->SetText(CComBSTR(sText[i])); m_hr = m_ptr2->SetFont(pFontDuplicate); m_hr = m_ptr2->SetPara(pParaDuplicate); } m_hr = m_ptr2->EndOf(tomTable, tomMove, &lDelta); m_hr = m_ptr2->GetEnd(&end); } } } m_pREOle->Release(); }

Thank you RLWA32-6355 for all your help - it would never have been possible without!!

Answer 1

void CMHMView::InsertTableRow(long index, long& start, long& end, long ncells, 
    long cellwidths[], long skip, LPCTSTR* sText, BOOL bAppend)
{

    if (SUCCEEDED(m_hr))
    {
        long lDelta{};

        CComPtr<ITextFont> pFont;

        m_hr = m_ptr2->GetFont(&pFont);

        CComPtr<ITextRow> pRow;
        CComPtr<ITextFont> pFontDuplicate;

        m_hr = m_ptr2->GetRow(&pRow);
        m_hr = pFont->GetDuplicate(&pFontDuplicate);

        if (pRow && pFontDuplicate)
        {
            CComPtr<ITextPara> pPara, pParaDuplicate;
            m_hr = m_ptr2->GetPara(&pPara);
            m_hr = pPara->GetDuplicate(&pParaDuplicate);

            m_hr = pFontDuplicate->SetName(CComBSTR(L"Courier New"));
            m_hr = pFontDuplicate->SetSize(12.0f);

            m_hr = m_ptr2->MoveStart(tomTable, start, &lDelta);
            m_hr = m_ptr2->Collapse(tomEnd);
            if (bAppend)
            {
                m_hr = pRow->SetCellCount(ncells);
                for (int i = 0; i < ncells; i++)
                {
                    m_hr = pRow->SetCellIndex(i);
                    m_hr = pRow->SetCellWidth(cellwidths[i]);
                }

                m_hr = pRow->Insert(1);
                m_hr = m_ptr2->SetIndex(tomTable, index, 0);

                for (int i = 0; i < skip; i++)
                {
                    if (i > 0)
                        m_hr = m_ptr2->MoveStart(tomCell, 1, &lDelta);
                    m_hr = m_ptr2->SetText(CComBSTR(L""));
                }
                for (int i = 0; i < ncells; i++)
                {
                    if (i > 0)
                        m_hr = m_ptr2->MoveStart(tomCell, 1, &lDelta);

                    m_hr = m_ptr2->SetText(CComBSTR(sText[i]));
                    m_hr = m_ptr2->SetFont(pFontDuplicate);
                    m_hr = m_ptr2->SetPara(pParaDuplicate);

                }

                m_hr = m_ptr2->EndOf(tomTable, tomMove, &lDelta);


                m_hr = m_ptr2->GetEnd(&end);
            }
            else
            {           
                m_hr = m_ptr2->SetText(CComBSTR(L"\r"));
                m_hr = m_ptr2->Collapse(tomEnd);

                m_hr = pRow->SetCellCount(ncells);
                for (int i = 0; i < ncells; i++)
                {
                    m_hr = pRow->SetCellIndex(i);
                    m_hr = pRow->SetCellWidth(cellwidths[i]);
                    /*pRow->SetCellMergeFlags(tomHStartCell)*/
                }

                m_hr = pRow->Insert(1);
                m_hr = m_ptr2->SetIndex(tomTable, index, 0);

                for (int i = 0; i < ncells; i++)
                {
                    if (i > 0)
                        m_hr = m_ptr2->MoveStart(tomCell, 1, &lDelta);

                    m_hr = m_ptr2->SetText(CComBSTR(sText[i]));
                    m_hr = m_ptr2->SetFont(pFontDuplicate);
                    m_hr = m_ptr2->SetPara(pParaDuplicate);

                }

                m_hr = m_ptr2->EndOf(tomTable, tomMove, &lDelta);
                m_hr = m_ptr2->GetEnd(&end);

            }
        }
    }
    m_pREOle->Release();
}

RLWA32 49,536 Reputation points

2022-03-10T17:04:58.453+00:00

Look carefully at how you acquire and release interface pointers. Several appear to be acquired during InitialUpdate when the view is first created but they are either not released at all or are released at the end of the function (m_pREOle). So since m_pREOle is released after the first time the InsertTableRow function is called, any subsequent use will be problematic. When are m_ptd2 and m_ptr2 released? What if the user decides to abandon the document and start over? InitialUpdate will be called again.
Andre LeBlanc 21 Reputation points

2022-03-10T17:50:48.767+00:00

Understood, I didn't catch the m_pREOle issue - thanks. Right now I am still testing and calling the function from OnInitialUpdate. I guess I could create an Init and destroy function for handling initialization and destruction of said pointers - unless you have a better idea?
RLWA32 49,536 Reputation points

2022-03-10T21:17:41.43+00:00

Call me lazy, but its probably simpler to get the TOM interfaces from the control when you need them and release them when you've finished using them. That way you don't have to worry about object lifetimes and interface leakage.

Share via

Text Object Model and C++ -- General HowTo

1 answer

Your answer