IOleDocumentView::Metode UIActivate (docobj.h)

Artikel
08/23/2023

Mengaktifkan atau menonaktifkan elemen antarmuka pengguna tampilan dokumen, seperti menu, toolbar, dan akselerator.

Sintaks

HRESULT UIActivate(
  [in] BOOL fUIActivate
);

Parameter

[in] fUIActivate

Jika TRUE, tampilannya adalah mengaktifkan antarmuka penggunanya. Jika FALSE, tampilannya adalah menonaktifkan antarmuka penggunanya.

Menampilkan nilai

Metode ini mengembalikan S_OK pada keberhasilan. Kemungkinan nilai pengembalian lainnya termasuk yang berikut ini.

Menampilkan kode	Deskripsi
E_FAIL	Operasi gagal.
E_OUTOFMEMORY	Memori tidak cukup tersedia untuk operasi.
E_UNEXPECTED	Terjadi kesalahan tak terduga.

Keterangan

Catatan untuk Penelepon

Memanggil metode ini sebelum memanggil IOleDocumentView::SetInPlaceSite mengembalikan E_UNEXPECTED, karena tampilan harus dikaitkan dengan situs tampilan sebelum dapat mengaktifkan dirinya sendiri.

Ketika IOleDocumentView::UIActivate dipanggil sebagai bagian dari urutan aktivasi, panggilan harus mendahului panggilan ke IOleDocumentView::SetRect atau IOleDocumentView::SetRectComplex, karena jika tidak, dimensi tampilan tidak akan mempertanggungjawabkan ruang toolbar.

Untuk menonaktifkan tampilan, kontainer harus memanggil IOleDocumentView::Show dengan FALSE, diikuti oleh IOleDocumentView::UIActivate dengan FALSE.

Catatan untuk Pelaksana

Implementasi metode ini harus mewujudkan pseudocode berikut.

if (fActivate)
    {
    UI activate the view (do menu merging, show frame level tools, process accelerators)
    Take focus, and bring the view window forward.
    }
else
    call IOleInPlaceObject::UIDeactivate on this view

Selain itu, tampilan dapat dan harus berpartisipasi dalam penggabungan menu Bantuan yang diperluas.

Semua tampilan objek dokumen harus mendukung aktivasi di tempat. E_NOTIMPL bukan nilai pengembalian yang dapat diterima.

Persyaratan


Klien minimum yang didukung	Windows 2000 Professional [hanya aplikasi desktop]
Server minimum yang didukung	Windows 2000 Server [hanya aplikasi desktop]
Target Platform	Windows
Header	docobj.h