openForm (Tài liệu tham khảo về API máy khách)

Mở biểu mẫu thực thể hoặc biểu mẫu tạo nhanh.

Lưu ý

Để mở biểu mẫu chính dưới dạng hộp thoại, thay vào đó hãy sử dụng phương pháp navigateTo . Thông tin thêm: Mở biểu mẫu chính trong hộp thoại bằng API máy khách

Cú pháp

Xrm.Navigation.openForm(entityFormOptions, formParameters).then(successCallback, errorCallback);

Tham số

Tên	Kiểu	Bắt buộc	Description
`entityFormOptions`	Đối tượng	Có	Tùy chọn biểu mẫu để mở biểu mẫu. Xem đối tượng entityFormOptions
`formParameters`	Đối tượng	No	Một đối tượng từ điển truyền các tham số bổ sung vào biểu mẫu. Các thông số không hợp lệ sẽ gây ra lỗi. Để biết thông tin về việc chuyển tham số vào biểu mẫu, hãy xem đặt giá trị cột sử dụng các tham số được truyền cho biểu mẫu và Đặt cấu hình biểu mẫu để chấp nhận tham số chuỗi truy vấn tùy chỉnh.
`successCallback`	Function	No	Một hàm để thực hiện khi bản ghi được lưu trong biểu mẫu tạo nhanh. Hàm này được truyền một đối tượng như một tham số. Đối tượng có một mảng `savedEntityReference` với các thuộc tính sau đây để xác định (các) bản ghi được hiển thị hoặc tạo ra: - `entityType`: Tên lô-gic của bảng. - `id`: Một chuỗi biểu thị giá trị GUID cho bản ghi. - `name`: Giá trị cột chính của bản ghi được hiển thị hoặc đã tạo. LƯU Ý: - Hàm `successCallback` không được thực thi khi bạn mở biểu mẫu cho bản ghi hiện có hoặc mới. - Hàm `successCallback` chỉ được thực thi khi bạn lưu một bản ghi trong một biểu mẫu tạo nhanh đã được mở bằng phương pháp openForm.
`errorCallback`	Function	No	Một hàm để thực thi khi hoạt động không thành công.

đối tượng entityFormOptions

Đối tượng chứa các giá trị sau:

Tên	Kiểu	Bắt buộc	Description
`entityName`	String	Có	Tên lô-gic của bảng để hiển thị biểu mẫu.
`entityId`	String	No	ID của bản ghi bảng để hiển thị biểu mẫu.
`formId`	String	No	ID của mẫu biểu mẫu sẽ được hiển thị.
`cmdbar`	Bool	No	Cho biết có hiển thị thanh lệnh hay không. Nếu bạn không chỉ định tham số này, thanh lệnh được hiển thị theo mặc định. Yêu cầu tham số `openInNewWindow` truyền là đúng.
`createFromEntity`	Tra cứu	No	Chỉ định một bản ghi sẽ cung cấp giá trị mặc định dựa trên các giá trị cột được ánh xạ. Đối tượng tra cứu có các thuộc tính Chuỗi sau: `entityType`, và `nameid`(tùy chọn).
`openInNewWindow`	Bool	No	Cho biết hiển thị biểu mẫu trong cửa sổ mới hay tab mới. `true` Nếu bạn chỉ định và không xác định giá trị cho chiều cao hoặc chiều rộng, biểu mẫu sẽ hiển thị trong tab mới. Việc mở biểu mẫu trong cửa sổ mới hoặc tab mới sẽ làm chậm việc hiển thị biểu mẫu so với việc mở biểu mẫu trên cùng một tab; thay vào đó, hãy cân nhắc việc mở biểu mẫu trong hộp thoại biểu mẫu chính. Thuộc tính này hiện không được hỗ trợ cho biểu mẫu Tạo Nhanh, vì không thể mở chúng trong cửa sổ hoặc tab mới.
`height`	Số điện thoại	No	Chiều cao của cửa sổ biểu mẫu sẽ được hiển thị bằng pixel. Yêu cầu tham số `openInNewWindow` truyền là đúng.
`width`	Số điện thoại	No	Chiều rộng của cửa sổ biểu mẫu sẽ được hiển thị bằng pixel. Yêu cầu tham số `openInNewWindow` truyền là đúng.
`navbar`	String	No	Kiểm soát xem thanh điều hướng có được hiển thị hay không và liệu điều hướng ứng dụng có khả dụng hay không bằng cách sử dụng các khu vực và khu vực phụ được xác định trong sơ đồ trang web. Các giá trị hợp lệ là: `on`, `off`hoặc `entity`. Yêu cầu chuyển tham số openInNewWindow là đúng. - `on`: Thanh dẫn hướng được hiển thị. Đây là hành vi mặc định nếu tham số navbar không được sử dụng. - `off`: Thanh dẫn hướng không được hiển thị. Mọi người có thể điều hướng bằng các yếu tố giao diện người dùng khác hoặc các nút quay lại và chuyển tiếp. - `entity`: Trên biểu mẫu, chỉ có các tùy chọn dẫn hướng cho các bảng liên quan mới khả dụng. Sau khi dẫn hướng đến bảng liên quan, nút quay lại sẽ được hiển thị trong thanh dẫn hướng để cho phép quay lại bản ghi gốc.
`relationship`	Đối tượng	No	Xác định đối tượng quan hệ để hiển thị các bản ghi liên quan trên biểu mẫu. Xem đối tượng mối quan hệ
`selectedStageId`	String	No	ID của giai đoạn đã chọn trong phiên bản quy trình kinh doanh.
`useQuickCreateForm`	Bool	No	Cho biết có mở biểu mẫu tạo nhanh hay không. Bảng phải bật tùy chọn Cho phép Tạo Nhanh để biểu mẫu tạo nhanh được hiển thị và bạn cũng phải thêm bảng và biểu mẫu tạo nhanh vào ứng dụng của mình. Nếu bạn không chỉ định giá trị của `useQuickCreateForm`, mặc định sẽ được đặt là `false`.

đối tượng quan hệ

Đối tượng có các giá trị sau đây.

Tên	Kiểu	Description
`attributeName`	String	Tên của cột được dùng cho mối quan hệ.
`name`	String	Tên của cột được dùng cho mối quan hệ.
`navigationPropertyName`	String	Tên của cột được dùng cho mối quan hệ.
`relationshipType`	Số điện thoại	Loại mối quan hệ. Xác định một trong các giá trị sau: - 0:OneToMany - 1:ManyToMany
`roleType`	Số điện thoại	Loại vai trò trong mối quan hệ. Xác định một trong các giá trị sau: - 1:Tham chiếu - 2:AssociationEntity

Ghi chú

Bạn phải sử dụng phương pháp này để mở bảng hoặc tạo nhanh biểu mẫu thay vì các phương pháp Xrm.Utility.openEntityForm và Xrm.Utility.openQuickCreate không được chấp nhận.

Sử dụng setActiveProcess để hiển thị một quy trình kinh doanh cụ thể và đặtActiveProcessInstance để hiển thị một phiên bản quy trình kinh doanh cụ thể trên biểu mẫu.

Ví dụ

Ví dụ 1: Mở biểu mẫu cho bản ghi hiện có

Mã mẫu sau đây sẽ mở ra một biểu mẫu liên hệ để hiển thị bản ghi liên hệ hiện có:

var entityFormOptions = {};
entityFormOptions["entityName"] = "contact";
entityFormOptions["entityId"] = "00aa00aa-bb11-cc22-dd33-44ee44ee44ee";

// Open the form.
Xrm.Navigation.openForm(entityFormOptions).then(
    function (success) {
        console.log(success);
    },
    function (error) {
        console.log(error);
    });

Ví dụ 2: Mở biểu mẫu cho bản ghi mới

Mã mẫu sau đây sẽ mở ra một biểu mẫu liên hệ với một số giá trị được điền sẵn để tạo một bản ghi mới:

var entityFormOptions = {};
entityFormOptions["entityName"] = "contact";

// Set default values for the Contact form
var formParameters = {};
formParameters["firstname"] = "Sample";
formParameters["lastname"] = "Contact";
formParameters["fullname"] = "Sample Contact";
formParameters["emailaddress1"] = "contact@adventure-works.com";
formParameters["jobtitle"] = "Sr. Marketing Manager";
formParameters["donotemail"] = "1";
formParameters["description"] = "Default values for this record were set programmatically.";

// Set lookup column
formParameters["preferredsystemuserid"] = "3493e403-fc0c-eb11-a813-002248e258e0"; // ID of the user.
formParameters["preferredsystemuseridname"] = "Admin user"; // Name of the user.
// End of set lookup column

// Open the form.
Xrm.Navigation.openForm(entityFormOptions, formParameters).then(
    function (success) {
        console.log(success);
    },
    function (error) {
        console.log(error);
    });

Ví dụ 3: Mở biểu mẫu cho bản ghi mới (tra cứu phức tạp)

Mã mẫu sau đây sẽ mở ra một biểu mẫu hoạt động với một số giá trị được điền sẵn (bao gồm tra cứu phức tạp) để tạo bản ghi mới:

var entityFormOptions = {};
entityFormOptions["entityName"] = "email";

// Set default values for the Contact form
var formParameters = {};
formParameters["subject"] = "Sample";
formParameters["description"] = "Default values for this record were set programmatically.";

// Set lookup column
formParameters["regardingobjectid"] = "3493e403-fc0c-eb11-a813-002248e258e0"; // ID of the user.
formParameters["regardingobjectidname"] = "Admin user"; // Name of the user.
formParameters["regardingobjectidtype"] = "systemuser"; // Table name. 
// End of set lookup column

// Open the form.
Xrm.Navigation.openForm(entityFormOptions, formParameters).then(
    function (success) {
        console.log(success);
    },
    function (error) {
        console.log(error);
    });

Ví dụ 4: Mở biểu mẫu tạo nhanh

Mã mẫu sau đây sẽ mở ra một biểu mẫu liên hệ tạo nhanh với một số giá trị được điền sẵn:

var entityFormOptions = {};
entityFormOptions["entityName"] = "contact";
entityFormOptions["useQuickCreateForm"] = true;

// Set default values for the Contact form
var formParameters = {};
formParameters["firstname"] = "Sample";
formParameters["lastname"] = "Contact";
formParameters["fullname"] = "Sample Contact";
formParameters["emailaddress1"] = "contact@adventure-works.com";
formParameters["jobtitle"] = "Sr. Marketing Manager";
formParameters["donotemail"] = "1";
formParameters["description"] = "Default values for this record were set programmatically.";

// Set lookup column
formParameters["preferredsystemuserid"] = "3493e403-fc0c-eb11-a813-002248e258e0"; // ID of the user.
formParameters["preferredsystemuseridname"] = "Admin user"; // Name of the user.
formParameters["preferredsystemuseridtype"] = "systemuser"; // Table name.
// End of set lookup column

// Open the form.
Xrm.Navigation.openForm(entityFormOptions, formParameters).then(
    function (success) {
        console.log(success);
    },
    function (error) {
        console.log(error);
    });

Xrm.Navigation

Phản hồi

Trang này có hữu ích không?

Last updated on 2025-10-04