Kelas CJumpList

CJumpList adalah daftar pintasan yang terungkap saat Anda mengklik kanan ikon di bilah tugas.

Sintaks

class CJumpList;

Anggota

Konstruktor Publik

Hierarki Warisan

CJumpList

Persyaratan

Header: afxadv.h

CJumpList::~CJumpList

Menghancurkan objek CJumpList .

~CJumpList();

CJumpList::AbortList

Membatalkan transaksi pembuatan daftar tanpa melakukan.

void AbortList();

Keterangan

Memanggil metode ini memiliki efek yang sama dengan menghancurkan CJumpList tanpa memanggil CommitList.

CJumpList::AddDestination

Menambahkan tujuan ke daftar.

BOOL AddDestination(
    LPCTSTR lpcszCategoryName,
    LPCTSTR strDestinationPath);

BOOL AddDestination(
    LPCTSTR strCategoryName,
    IShellItem* pShellItem);

BOOL AddDestination(
    LPCTSTR strCategoryName,
    IShellLink* pShellLink);

Parameter

lpcszCategoryName
Menentukan nama kategori. Jika kategori yang ditentukan tidak ada, kategori tersebut akan dibuat.

strDestinationPath
Menentukan jalur ke file tujuan.

strCategoryName
Menentukan nama kategori. Jika kategori yang ditentukan tidak ada, kategori tersebut akan dibuat.

pShellItem
Menentukan Item Shell yang mewakili tujuan yang ditambahkan.

pShellLink
Menentukan Tautan Shell yang mewakili tujuan yang ditambahkan.

Tampilkan Nilai

Keterangan

Instans CJumpList secara internal mengakumulasi tujuan yang ditambahkan lalu menerapkannya di CommitList.

CJumpList::AddKnownCategory

Menambahkan Kategori yang Diketahui ke daftar.

BOOL AddKnownCategory(KNOWNDESTCATEGORY category);

Parameter

category
Menentukan jenis kategori yang diketahui. Dapat berupa KDC_RECENT, atau KDC_KNOWN.

Tampilkan Nilai

Keterangan

Kategori yang Diketahui adalah kategori Sering dan Terbaru yang akan kami hitung secara otomatis untuk setiap aplikasi yang menggunakan SHAddToRecentDocs (atau secara tidak langsung menggunakannya karena shell akan memanggilnya atas nama aplikasi dalam beberapa skenario).

CJumpList::AddTask

Menambahkan item ke kategori Tugas kanonis.

BOOL AddTask(
    LPCTSTR strTargetExecutablePath,
    LPCTSTR strCommandLineArgs,
    LPCTSTR strTitle,
    LPCTSTR strIconLocation,
    int iIconIndex);

BOOL AddTask(IShellLink* pShellLink);

Parameter

strTargetExecutablePath
Menentukan jalur tugas target.

strCommandLineArgs
Menentukan argumen baris perintah dari executable yang ditentukan oleh strTargetExecutablePath.

strTitle
Nama tugas yang akan ditampilkan di Daftar Tujuan.

strIconLocation
Lokasi ikon yang akan ditampilkan di Daftar Tujuan bersama dengan judul.

iIconIndex
Indeks ikon.

pShellLink
Shell Link yang mewakili tugas yang akan ditambahkan.

Tampilkan Nilai

Keterangan

Instans CJumpList mengakumulasi tugas yang ditentukan dan menambahkannya ke Daftar Tujuan selama CommitList. Item tugas akan muncul dalam kategori di bagian bawah menu tujuan aplikasi. Kategori ini lebih diutamakan daripada semua kategori lain ketika diisi di UI.

CJumpList::AddTasks

Menambahkan item ke kategori Tugas kanonis.

BOOL AddTasks(IObjectArray* pObjectCollection);

Parameter

pObjectCollection
Kumpulan tugas yang akan ditambahkan.

Tampilkan Nilai

Keterangan

Instans CJumpList mengumpulkan tugas yang ditentukan dan menambahkannya ke Daftar Tujuan selama CommitList. Item tugas akan muncul dalam kategori di bagian bawah menu tujuan aplikasi. Kategori ini lebih diutamakan daripada semua kategori lain ketika diisi di UI.

CJumpList::AddTaskSeparator

Menambahkan pemisah antar tugas.

BOOL AddTaskSeparator();

Tampilkan Nilai

Bukan nol jika berhasil, 0 jika tidak.

CJumpList::CJumpList

Membuat CJumpList objek.

CJumpList(BOOL bAutoCommit = TRUE);

Parameter

bAutoCommit
Jika parameter ini FALSE, daftar tidak secara otomatis diterapkan dalam destruktor.

CJumpList::ClearAll

Menghapus semua tugas dan tujuan yang telah ditambahkan ke instans CJumpList saat ini sejauh ini.

void ClearAll();

Keterangan

Metode ini menghapus dan merilis semua data dan antarmuka internal.

CJumpList::ClearAllDestinations

Menghapus semua tujuan yang telah ditambahkan ke instans CJumpList saat ini sejauh ini.

void ClearAllDestinations();

Keterangan

Panggil fungsi ini jika Anda perlu menghapus semua tujuan yang telah ditambahkan sejauh ini dalam sesi pembuatan daftar tujuan saat ini dan tambahkan tujuan lain lagi. Jika internal ICustomDestinationList telah diinisialisasi, itu dibiarkan hidup.

CJumpList::CommitList

Mengakhiri transaksi pembuatan daftar dan menerapkan daftar yang dilaporkan ke penyimpanan terkait (registri dalam kasus ini).

BOOL CommitList();

Tampilkan Nilai

Keterangan

Penerapannya adalah atom. Kesalahan akan dikembalikan jika penerapan gagal. Ketika CommitList dipanggil, daftar item yang dihapus saat ini akan dibersihkan. Memanggil metode ini mengatur ulang objek sehingga tidak memiliki transaksi pembangun daftar aktif. Untuk memperbarui daftar, BeginList perlu dipanggil lagi.

CJumpList::GetDestinationList

Mengambil penunjuk antarmuka ke daftar tujuan.

ICustomDestinationList* GetDestinationList();

Tampilkan Nilai

Keterangan

Jika daftar lompat belum diinisialisasi, atau telah dilakukan atau dibatalkan, nilai yang dikembalikan adalah NULL.

CJumpList::GetMaxSlots

Mengambil jumlah maksimum item, termasuk header kategori yang dapat ditampilkan di menu tujuan aplikasi panggilan.

UINT GetMaxSlots() const;

Tampilkan Nilai

Keterangan

Aplikasi hanya dapat melaporkan sejumlah item dan header kategori yang digabungkan hingga nilai ini. Jika memanggil ke AppendCategory, AppendKnownCategory, atau AddUserTasks melebihi nomor ini, mereka akan mengembalikan kegagalan.

CJumpList::GetRemovedItems

Mengembalikan array item yang mewakili tujuan yang dihapus.

IObjectArray* GetRemovedItems();

Tampilkan Nilai

Keterangan

Tujuan yang dihapus diambil selama inisialisasi jump list. Saat membuat daftar tujuan baru, aplikasi diharapkan untuk terlebih dahulu memproses daftar tujuan yang dihapus, menghapus data pelacakan mereka untuk item apa pun yang dikembalikan oleh enumerator daftar yang dihapus. Jika aplikasi mencoba menyediakan item yang baru saja dihapus dalam transaksi yang panggilan saat ini dimulai BeginList , panggilan metode yang menambahkan ulang item tersebut akan gagal, untuk memastikan bahwa aplikasi menghormati daftar yang dihapus.

CJumpList::InitializeList

Memulai transaksi pembuatan daftar.

BOOL InitializeList();

Tampilkan Nilai

Keterangan

Anda tidak perlu memanggil metode ini secara eksplisit kecuali Anda ingin mengambil penunjuk untuk ICustomDestinationList menggunakan GetDestinationList, jumlah slot yang tersedia menggunakan GetMaxSlots, atau daftar item yang dihapus menggunakan GetRemovedItems.

CJumpList::SetAppID

Mengatur ID Model Pengguna Aplikasi untuk daftar yang akan dibuat.

void SetAppID(LPCTSTR strAppID);

Parameter

strAppID
String yang menentukan ID Model Pengguna Aplikasi.

Lihat juga

Kelas