L_AnnSetSnapToGrid

Functions

• L_AnnGetSnapToGrid

Topics

• Annotation Objects - Automated Features

Example

This sample

• gets the current state of the snap-to-grid
• changes the snap to grid to grid size of 10, lines every ten row of dots, solid red lines
• enables the snap to grid

  L_TCHAR* getLineStyleString(L_UINT uLineStyle) 
  { 
     TCHAR *pszLineStyle = TEXT(""); 
     switch(uLineStyle) 
     { 
     case ANNLINE_SOLID: 
        pszLineStyle = TEXT("ANNLINE_SOLID"); 
        break; 
     case ANNLINE_DASH: 
        pszLineStyle = TEXT("ANNLINE_DASH"); 
        break; 
   
     case ANNLINE_DOT: 
        pszLineStyle = TEXT("ANNLINE_DOT"); 
        break; 
   
     case ANNLINE_DASHDOT: 
        pszLineStyle = TEXT("ANNLINE_DASHDOT"); 
        break; 
   
     case ANNLINE_DASHDOTDOT: 
        pszLineStyle = TEXT("ANNLINE_DASHDOTDOT"); 
        break; 
   
     case ANNLINE_NULL: 
        pszLineStyle = TEXT("ANNLINE_NULL"); 
        break; 
     } 
     return pszLineStyle; 
  } 
   
  L_VOID DisplaySnapToGrid(HANNOBJECT hAutomation, L_TCHAR *pszTitle) 
  { 
     L_TCHAR szMsg[200] = {0}; 
     ANNSNAPTOGRIDOPTIONS options = {0}; 
     L_UINT uSnapToGridMode = ANN_SNAPTOGRID_OFF; 
     options.uStructSize = sizeof(ANNSNAPTOGRIDOPTIONS); 
     options.uFlags = ANNSNAPTOGRID_ALL; 
     L_INT nRet = L_AnnGetSnapToGrid(hAutomation, &uSnapToGridMode,  &options); 
     if (nRet == SUCCESS) 
     { 
        wsprintf(szMsg, TEXT("uSnapToGridMode[%s]\ncrGridColor[0x%x]\nuGridLength[%d]\nuLineSpacing[%d]\nuLineStyle[%s]\nbEnableSnap[%s]\nbShowGrid[%s]\nbAutoChangeGridLength[%s]"), 
           uSnapToGridMode == ANN_SNAPTOGRID_OFF ? TEXT("ANN_SNAPTOGRID_OFF") : TEXT("ANN_SNAPTOGRID_ON"), 
           options.crGridColor, 
           options.uGridLength, 
           options.uLineSpacing, 
           getLineStyleString(options.uLineStyle), 
           options.bEnableSnap ? TEXT("TRUE") : TEXT("FALSE"), 
           options.bShowGrid ? TEXT("TRUE") : TEXT("FALSE"), 
           options.bAutoChangeGridLength ? TEXT("TRUE") : TEXT("FALSE") 
           ); 
        MessageBox(NULL, szMsg, pszTitle, MB_OK); 
     } 
  } 
   
  L_INT SampleAnnSetSnapToGridExample(HANNOBJECT hAutomation) 
  { 
     L_INT nRet = SUCCESS; 
     // Make sure that the snap-to-grid features is enabled 
     L_AnnSetOptions(hAutomation, OPTIONS_NEW_ALL | OPTIONS_NEW_SNAPTOGRID); 
   
     // Display current snap-to-grid settings 
     DisplaySnapToGrid(hAutomation, TEXT("Original Settings")); 
   
   
     // Change snap-to-grid to grid size of 10, lines every ten row of dots, solid red lines, and enable it 
     ANNSNAPTOGRIDOPTIONS options = {0}; 
     options.uStructSize = sizeof(ANNSNAPTOGRIDOPTIONS); 
     options.uFlags = ANNSNAPTOGRID_ALL; 
     options.bAutoChangeGridLength = TRUE; 
     options.bEnableSnap = TRUE; 
     options.bShowGrid = TRUE; 
     options.crGridColor = RGB(255,0,0); 
     options.uGridLength = 10; 
     options.uLineSpacing = 10; 
     options.uLineStyle = ANNLINE_SOLID; 
     options.nReserved = 0; 
   
     nRet = L_AnnSetSnapToGrid(hAutomation, ANN_SNAPTOGRID_ON, &options); 
     if (nRet == SUCCESS) 
     { 
        DisplaySnapToGrid(hAutomation, TEXT("New Settings")); 
     } 
     return nRet; 
  }