Kelas CUserTool
Alat pengguna adalah item menu yang menjalankan aplikasi eksternal. Tab Alat dari kotak dialog Kustomisasi ( CMFCToolBarsCustomizeDialog Class) memungkinkan pengguna untuk menambahkan alat pengguna, dan untuk menentukan nama, perintah, argumen, dan direktori awal untuk setiap alat pengguna.
Sintaks
class CUserTool : public CObject
Anggota
Metode Publik
| Nama | Deskripsi |
|---|---|
| CUserTool::CopyiconToclipboard | |
| CUserTool::D rawToolIcon | Menggambar ikon alat pengguna dalam persegi panjang tertentu. |
| CUserTool::GetCommand | Mengembalikan string yang berisi teks perintah yang terkait dengan alat pengguna. |
| CUserTool::GetCommandId | Mengembalikan ID perintah item menu alat pengguna. |
| CUserTool::Invoke | Menjalankan perintah yang terkait dengan alat pengguna. |
| CUserTool::Serialize | Membaca atau menulis objek ini dari atau ke arsip. (Penimpaan CObject::Serialize.) |
| CUserTool::SetCommand | Mengatur perintah yang terkait dengan alat pengguna. |
| CUserTool::SetToolIcon | Memuat ikon untuk alat pengguna dari aplikasi yang terkait dengan alat. |
Metode yang Dilindungi
| Nama | Deskripsi |
|---|---|
| CUserTool::LoadDefaultIcon | Memuat ikon default untuk alat pengguna. |
Anggota Data
| Nama | Deskripsi |
|---|---|
| CUserTool::m_strArguments | Argumen baris perintah untuk alat pengguna. |
| CUserTool::m_strInitialDirectory | Direktori awal untuk alat pengguna. |
| CUserTool::m_strLabel | Nama alat yang ditampilkan dalam item menu untuk alat. |
Keterangan
Untuk informasi selengkapnya tentang cara mengaktifkan alat pengguna di aplikasi Anda, lihat Kelas CUserToolsManager.
Contoh
Contoh berikut menunjukkan cara membuat alat dari CUserToolsManager objek, mengatur m_strLabel variabel anggota, dan mengatur aplikasi yang dijalankan alat pengguna. Cuplikan kode ini adalah bagian dari sampel Demo Visual Studio.
// CUserToolsManager* pUserToolsManager
CUserTool* pTool1 = pUserToolsManager->CreateNewTool();
pTool1->m_strLabel = _T("&Notepad");
pTool1->SetCommand(_T("notepad.exe"));
Hierarki Warisan
Persyaratan
Header: afxusertool.h
CUserTool::CopyiconToclipboard
Untuk detail selengkapnya, lihat kode sumber yang terletak di folder VC\atlmfc\src\mfc dari penginstalan Visual Studio Anda.
BOOL CopyIconToClipboard();
Tampilkan Nilai
Keterangan
CUserTool::D rawToolIcon
Menggambar ikon alat pengguna di tengah persegi panjang tertentu.
void DrawToolIcon(
CDC* pDC,
const CRect& rectImage);
Parameter
pDC
[di] Penunjuk ke konteks perangkat.
rectImage
[di] Menentukan koordinat area untuk menampilkan ikon.
CUserTool::GetCommand
Mengembalikan string yang berisi teks perintah yang terkait dengan alat pengguna.
const CString& GetCommand() const;
Tampilkan Nilai
Referensi ke CString objek yang berisi teks perintah yang terkait dengan alat pengguna.
CUserTool::GetCommandId
Mengembalikan ID perintah alat pengguna.
UINT GetCommandId() const;
Tampilkan Nilai
ID perintah alat pengguna ini.
CUserTool::Invoke
Menjalankan perintah yang terkait dengan alat pengguna.
virtual BOOL Invoke();
Tampilkan Nilai
Bukan nol jika perintah berhasil dijalankan; jika tidak, 0.
Keterangan
Memanggil ShellExecute untuk menjalankan perintah yang terkait dengan alat pengguna. Fungsi gagal jika perintah kosong atau jika ShellExecute gagal.
CUserTool::LoadDefaultIcon
Memuat ikon default untuk alat pengguna.
virtual HICON LoadDefaultIcon();
Tampilkan Nilai
Handel ke ikon yang dimuat ( HICON), atau NULL jika ikon default tidak dapat dimuat.
Keterangan
Kerangka kerja memanggil metode ini ketika tidak dapat memuat ikon untuk alat yang ditentukan pengguna dari file alat yang dapat dieksekusi.
Ambil alih metode ini untuk menyediakan ikon alat default Anda sendiri.
CUserTool::m_strArguments
Argumen baris perintah untuk alat pengguna.
CString m_strArguments;
Keterangan
String ini diteruskan ke alat saat Anda memanggil CUserTool::Invoke atau ketika pengguna mengklik perintah yang terkait dengan alat ini.
CUserTool::m_strInitialDirectory
Menentukan direktori awal untuk alat pengguna.
CString m_strInitialDirectory;
Keterangan
Variabel ini menentukan direktori awal yang dijalankan alat saat Anda memanggil CUserTool::Invoke atau ketika pengguna mengklik perintah yang terkait dengan alat ini.
CUserTool::m_strLabel
Label yang ditampilkan dalam item menu untuk alat.
CString m_strLabel;
CUserTool::Serialize
Untuk detail selengkapnya, lihat kode sumber yang terletak di folder VC\atlmfc\src\mfc dari penginstalan Visual Studio Anda.
virtual void Serialize(CArchive& ar);
Parameter
[di] Ar
Keterangan
CUserTool::SetCommand
Mengatur aplikasi yang dijalankan alat pengguna.
void SetCommand(LPCTSTR lpszCmd);
Parameter
lpszCmd
[di] Menentukan aplikasi baru yang akan dikaitkan dengan alat pengguna.
Keterangan
Panggil metode ini untuk mengatur aplikasi baru yang dijalankan alat pengguna. Metode ini menghancurkan ikon lama dan memuat ikon baru dari aplikasi yang diberikan. Jika tidak dapat memuat ikon dari aplikasi, ikon default untuk alat pengguna dimuat dengan memanggil CUserTool::LoadDefaultIcon.
CUserTool::SetToolIcon
Memuat ikon untuk alat pengguna dari aplikasi yang digunakan alat.
virtual HICON SetToolIcon();
Tampilkan Nilai
Handel ke ikon yang dimuat.
Keterangan
Panggil metode ini untuk memuat ikon yang akan ditampilkan pada item menu. Metode ini mencari ikon dalam file yang dapat dieksekusi yang digunakan alat. Jika tidak memiliki ikon default, ikon yang disediakan oleh CUserTool::LoadDefaultIcon digunakan sebagai gantinya.
Lihat juga
Bagan Hierarki
Kelas
Kelas CWinAppEx
Kelas CUserToolsManager