Codejock Software Migrating Guide

Version 12.0

April 28, 2008

Xtreme Toolkit Pro

	SPRINTF_S method generated errors with /clr build option. It was removed from our sources. To fix compiler error replace SPRINTF_S to _vstprintf and remove second parameter. Example: Previous versions: SPRINTF_S(buff, _countof(buff), _T("%lu"), count); 12.0.0 and higher versions: //Add this to the top of the source file where SPRINTF_S is used AFX_INLINE int SPRINTF_S(TCHAR buffer, size_t count, const TCHAR format, ...) { va_list args; va_start(args, format); #if (_MSC_VER > 1310) // VS2005 int result = _vstprintf_s(buffer, count, format, args); #else int result = _vstprintf(buffer, format, args);UNREFERENCED_PARAMETER(count); #endif va_end(args); return result; } //If using the above code you can leave your function as it was, or you can modify the above code //to suite your version of Visual Studio SPRINTF_S(buff, _countof(buff), _T("%lu"), count);
	Color resources moved to Common sources. Use XTP_IDS_CLR_XXX instead of XT_IDS_CLR_XXX. For example replace XT_IDS_CLR_WHITE to XTP_IDS_CLR_WHITE to fix compiler error Previous versions: XT_IDS_CLR_WHITE 12.0.0 and higher versions: XTP_IDS_CLR_WHITE
	CXTPStatusBarLogoPane is obsolete now, use CXTPStatusBarPane instead. Replace CXTPStatusBarLogoPane to CXTPStatusBarPane class. Use the following code to create a StatusBar pane with an Icon in 12.0.0 and higher versions: CXTPStatusBarPane* pPane = m_wndStatusBar.AddIndicator(ID_INDICATOR_LOGO, 0); pPane->SetText(_T("Codejock Software")); pPane->SetTextColor(0x915f36); CXTPPaintManager::CNonClientMetrics ncm; ncm.lfMenuFont.lfWeight = FW_BOLD; pPane->SetTextFont(&ncm.lfMenuFont);
	Reworked CXTResize. Now it uses Window Client size - not whole window rect. CRect CXTResize::m_rcWindow changed to CSize CXTResize::m_szWindow. Instead m_rcWindow member variable use m_szWindow. Previous versions: m_szMin = m_rcWindow.Size(); 12.0.0 and higher versions: m_szMin = m_szWindow; Previous versions: if (rcBorders != m_rcBorders) { CPoint ptOffset(rcBorders.left - m_rcBorders.left, rcBorders.top - m_rcBorders.top); CRect rcWindow; GetWindowRect(rcWindow); rcWindow.right += rcBorders.left + rcBorders.right - m_rcBorders.left - m_rcBorders.right; rcWindow.bottom += rcBorders.top + rcBorders.bottom - m_rcBorders.top - m_rcBorders.bottom; Offset(ptOffset); m_rcWindow = rcWindow; MoveWindow(rcWindow, TRUE); } 12.0.0 and higher versions: if (rcBorders != m_rcBorders) { CPoint ptOffset(rcBorders.left - m_rcBorders.left, rcBorders.top - m_rcBorders.top); CSize szOffset(rcBorders.left + rcBorders.right - m_rcBorders.left - m_rcBorders.right, rcBorders.top + rcBorders.bottom - m_rcBorders.top - m_rcBorders.bottom); CRect rcWindow; GetWindowRect(rcWindow); rcWindow.BottomRight() += szOffset; Offset(ptOffset); m_szWindow += szOffset; m_szMin += szOffset; MoveWindow(rcWindow, TRUE); }

Xtreme CommandBars

CXTPPrintPreview class moved to our Sources. Please remove it from your application sources

Reworked CXTPShortcutManager to allow double key combinations, Format\SetAccel method now requires the CXTPShortcutManagerAccel parameter. Pass CXTPShortcutManagerAccel class to the Format\SetAccel method to fix error.

The following is a sample that shows how to work with the new classes:

	
	CXTPShortcutManagerAccelTable* pAccelTable = GetCommandBars()->GetShortcutManager()->GetDefaultAccelerator();
	
	int nAccelSize = pAccelTable ->GetCount();
	
	for (int i = 0; i < nAccelSize; i ++)
	{
		CXTPShortcutManagerAccel* accel = pAccelTable->GetAt(i);

		CString strKey =GetCommandBars()->GetShortcutManager()->Format(accel, NULL);

	}

Below are some scenarios that you might need to fix in your code:

Example 1 - Variable declared in Header File:

Previous versions header file:

	LPACCEL m_lpAccel;

12.0.0 and higher versions header file:

	CXTPShortcutManagerAccel* m_lpAccel;

Previous versions cpp file:

	if (m_lpAccel)
	{
		m_wndAccel.SetAccel(*m_lpAccel);
	}

12.0.0 and higher versions cpp file:

	if (m_lpAccel)
	{
		m_wndAccel.SetAccel(m_lpAccel);
	}

Example 2 - Variable declared in CPP File:

Previous versions cpp file:

	m_lpAccel = new ACCEL [m_nAccelSize];

12.0.0 and higher versions cpp file:

	m_lpAccel = new CXTPShortcutManagerAccel [m_nAccelSize];

Example 3:

Previous versions cpp file:

	m_lpAccel = new ACCEL [m_nAccelSize];
	::CopyAcceleratorTable (hAccelTable, m_lpAccel, m_nAccelSize);

12.0.0 and higher versions cpp file:

	int m_nAccelSize = pAccelTable->GetCount();
	for (int i = 0; i < nAccelSize; i ++)
		{
	          m_lpAccel[i] = m_pAccelTable->GetAt ( i );
	}

Xtreme Ribbon Bar

To prevent conflict with Microsoft headers CXTPRibbonBar::IsMinimized, CXTPRibbonBar::SetMinimized were renamed to CXTPRibbonBar::IsRibbonMinimized/CXTPRibbonBar::SetRibbonMinimized.

Example:

Previous versions:

	pRibbonBar->SetMinimized(!pRibbonBar->IsMinimized());

12.0.0 and higher versions:

	pRibbonBar->SetRibbonMinimized(!pRibbonBar->IsRibbonMinimized());

Version 10.1

April 5, 2006

Xtreme Calendar Pro

	The Data Base data provider DB structure changed: * Table 'Event' - Field renamed: from Description to Body - New field added: ScheduleID type: Number - New field added: IsReminder type: Number * Table 'RecurrencePattern' - New field added: CustomPropertiesXMLData type: Memo If you need to use old mdb data fiels with a version 10 - please make corresponding changes manually.
	GetProperty(XTP_CALENDAR_PROP_DBProviderCacheMode) changed to GetCacheMode, SetProperty(XTP_CALENDAR_PROP_DBProviderCacheMode) to SetCacheMode
	xtpCalendarDBCacheModeOnRepeat xtpCalendarDBCacheModeOnClear xtpCalendarDBCacheModeOff renamed as xtpCalendarDPCacheModeOnRepeat xtpCalendarDPCacheModeOnClear xtpCalendarDPCacheModeOff

Version 9.80

September 26, 2005

Xtreme CommandBars

	Reworked CXTPShortcutManager to allow shortcuts customization in Dialogs. XTPShortcutManager glabal function removed, use pCommanBars->GetShortcutManager() instead. CXTPCommandBars::LoadCommandBars and CXTPCommandBars::SaveCommandBars now save/restore shortcuts too. Call pCommanBars->GetShortcutManager()->SetAccelerators(IDR_MAINFRAME) to enable it.
	Reworked CXTPDialog to allow Docking and Customization, Removed CXTPDialog::SetMenuBar because of it. use CXTPCommandBars::SetMenu(...) instead, for example: VERIFY(InitCommandBars()); CXTPCommandBars* pCommandBars = GetCommandBars(); pCommandBars->SetMenu(_T("Menu Bar"), IDR_MENU)
	Because of spell error CXTPControl::GetRawRect and CXTPControl::SetRawRect changed to CXTPControl::GetRowRect and CXTPControl::SetRowRect

Xtreme Report Control

	CXTPReportView::SetReportCtrl method added to allow custom CXTPReportControl child class, please use CXTPReportView::GetReportCtrl() instead of m_wndReport
	Changed enumerators names: xtpGrid* to xtpReportGrid; xtpColumn to xtpReportColumn*

Xtreme Suite Pro

	Xtreme Suite ActiveX has had some significant changes made that need to be noted before updrading to 9.80 and above. The TaskPanel and ShortcutBar controls have been removed from the SuiteCtrls.OCX file. Both the TaskPanel and ShortcutBar have their own OCX file. Important Please note that all changes should be made by opening up the files in a text editor such as WordPad. Do not open up the project and try to edit it with Visual Studio.
	To upgrade existing VB6 project please follow the steps below: Adding the GUID for TaskPanel and ShortcutBar Controls 1. If you are using the TaskPanel control add the following GUID to the .vbp and all .frm files the TaskPanel is used on: Object={B8E5842E-102B-4289-9D57-3B3F5B5E15D3}#9.80#0; TaskPanel.ocx 2. If you are using the ShortcutBar control add the following GUID to the .vbp and all .frm files the ShortcutBar is used on: Object={C8E5842E-102B-4289-9D57-3B3F5B5E15D3}#9.80#0; ShortcutBar.ocx Removing Uneeded GUIDs if Neccessary 3. If you do not use any other controls from the SuiteCtrls.OCX file from version before 9.80 then you can remove the GUID for the Suite Control from the .vbp and all .frm files: Object = "{A8E5842E-102B-4289-9D57-3B3F5B5E15D3}#9.60#0"; "SuiteCtrls.ocx" Renaming Control Names in .frm Files 4. Change all occurences of XtremeSuiteControls.TaskPanel to XtremeTaskPanel.TaskPanel in each .frm file that contains a TaskPanel control. 5. Change all occurences of XtremeSuiteControls.ShortcutBar to XtremeShortcutBar.ShortcutBar in each .frm file that contains a ShortcutBar control. Renaming Event Handler Parameters 6. Change all occurences of XtremeSuiteControls.ITaskPanel to XtremeTaskPanel.ITaskPanel in each .frm file that contains a TaskPanel control. 7. Change all occurences of XtremeSuiteControls.ITaskPanelItem to XtremeTaskPanel.ITaskPanelItem in each .frm file that contains a TaskPanel control. 8. Change all occurences of XtremeSuiteControls.ITaskPanelGroupItem to XtremeTaskPanel.ITaskPanelGroupItem in each .frm file that contains a TaskPanel control. 9. Change all occurences of XtremeSuiteControls.ITaskPanelGroup to XtremeTaskPanel.ITaskPanelGroup in each .frm file that contains a TaskPanel control. 10. Change all occurences of XtremeSuiteControls.IShortcutBarItem to XtremeShortcutBar.IShortcutBarItem in each .frm file that contains a ShortcutBar control. You can use Help\UpgradeFrom970.vbs script to upgrade all files.
	To upgrade existing C# .NET project please follow the steps below: Adding the TaskPanel and ShortcutBar References 1. If you are using the TaskPanel control add the reference after the XtremeSuiteControls reference in the .csproj file: <Reference Name = "XtremeTaskPanel" Guid = "{B8E5842E-102B-4289-9D57-3B3F5B5E15D3}" VersionMajor = "9" VersionMinor = "80" Lcid = "0" WrapperTool = "tlbimp" /> <Reference Name = "AxXtremeTaskPanel" Guid = "{B8E5842E-102B-4289-9D57-3B3F5B5E15D3}" VersionMajor = "9" VersionMinor = "80" Lcid = "0" WrapperTool = "aximp" /> 2. If you are using the ShortcutBar control add the reference after the XtremeSuiteControls reference in the .csproj file: <Reference Name = "XtremeShortcutBar" Guid = "{C8E5842E-102B-4289-9D57-3B3F5B5E15D3}" VersionMajor = "9" VersionMinor = "80" Lcid = "0" WrapperTool = "tlbimp" /> <Reference Name = "AxXtremeShortcutBar" Guid = "{C8E5842E-102B-4289-9D57-3B3F5B5E15D3}" VersionMajor = "9" VersionMinor = "80" Lcid = "0" WrapperTool = "aximp" /> 3. Important If your application still uses the PopupControl or TabControl you must update the VersionMajor and VersionMinor properties of the XtremeSuiteControls and AxXtremeSuiteControls reference in the .csproj file to the current major and minor version to avoid ambiguities. Removing Uneeded References if Neccessary 4. If you do not use any other controls from the SuiteCtrls.OCX file from versions before 9.80 (Popup Control or Tab Control) then you can remove the XtremeSuiteControls reference in the .csproj file: <Reference Name = "XtremeSuiteControls" Guid = "{A8E5842E-102B-4289-9D57-3B3F5B5E15D3}" VersionMajor = "9" VersionMinor = "60" Lcid = "0" WrapperTool = "tlbimp" /> <Reference Name = "AxXtremeSuiteControls" Guid = "{A8E5842E-102B-4289-9D57-3B3F5B5E15D3}" VersionMajor = "9" VersionMinor = "60" Lcid = "0" WrapperTool = "aximp" /> Updating "using" statements 5. If using the TaskPanel control, then add the following to all .cs files that may need it: using XtremeTaskPanel; 6. If using the ShortcutBar control, then add the following to all .cs files that may need it: using XtremeShortcutBar; Renaming Control Names in .cs Files 7. Change all occurences of AxXtremeSuiteControls.AxTaskPanel to AxXtremeTaskPanel.AxTaskPanel in each .cs file that contains a TaskPanel control. 8. Change all occurences of AxXtremeSuiteControls.AxShortcutBar to AxXtremeShortcutBar.AxShortcutBar in each .cs file that contains a ShortcutBar control. 9. Change all occurences of AxXtremeSuiteControls.AxShortcutCaption to AxXtremeShortcutBar.AxShortcutCaption in each .cs file that contains a ShortcutBar Caption control. Renaming Event Handler Parameters 10. Change all occurences of AxXtremeSuiteControls._DTaskPanelEvents_xxxxEvent to AxXtremeTaskPanel._DTaskPanelEvents_xxxxEvent in each .cs file that contains a TaskPanel control. 11. Change all occurences of AxXtremeSuiteControls._DShortcutBarEvents_xxxxEvent to AxXtremeShortcutBar._DShortcutBarEvents_xxxxEvent in each .cs file that contains a ShortcutBar control. Renaming XtremeSuiteControls Object References 12. Search through all your .cs files for the "XtremeSuiteControls" string. Update the string to "XtremeTaskPanel" if it refers to a TaskPanel Object. 13. Search through all your .cs files for the "XtremeSuiteControls" string. Update the string to "XtremeShortcutBar" if it refers to a ShortcutBar Object. 14. Search through all your .cs files for the "XtremeSuiteControls" string. Update the string to "XtremeShortcutBarCaption" if it refers to a ShortcutBarCaption Object.

Xtreme CommandBars

Important Note: The values for the theme enumeration have been changed. You will need to check to make sure that your theme has been
set correctly if you used the CommandBars Designer Studio (*.XML or *.XCB), or if you set the theme at design time in Visual Studio.
If you set the theme via code using a theme enumeration value then you do not need to make changes. Effected themes are Default, Office XP, and Office 2003.

Xtreme Docking Pane

Important Note: The values for the theme enumeration have been changed. You will need to check to make sure that your theme has been
set correctly if you hard coded the theme (used the integer representation of the theme), or if you set the theme at design time in Visual Studio.
If you set the theme via code using a theme enumeration value then you do not need to make changes. Effected themes are Office 2003 and Visio.


	Select a Component Category: To get started, select the development platform you will be working with from the Component Category list.
	Visual C++ Components Active-X Components for Visual Basic and .NET