Điều khiển API máy khách (bản xem trước)

[Bài viết này là tài liệu trước khi phát hành và có thể thay đổi.]

Power Pages khiển API Control máy khách thực hiện giao diện, cung cấp các phương pháp thông thường để quản lý giá trị biểu mẫu, trạng thái, khả năng hiển thị, yêu cầu và xác thực. Sử dụng tham chiếu này để xác định các phương thức có sẵn và trả về các loại. Đối với các loại giá trị dành riêng cho điều khiển và các thành viên bổ sung, hãy xem Các loại điều khiển API máy khách.

Quan trọng

  • Đây là một tính năng xem trước.
  • Các tính năng xem trước không được dùng cho sản xuất và có thể có chức năng bị hạn chế. Các tính năng này tuân theo các điều khoản sử dụng bổ sung và có sẵn trước khi phát hành chính thức để khách hàng có thể truy cập sớm và cung cấp phản hồi.
Phương pháp Trả về Mô tả
getDisabled() boolean Trả về true nếu điều khiển bị vô hiệu; nếu không, trả về false.
getRequired() boolean Trả về true nếu cần điều khiển; nếu không, trả về false.
getVisible() boolean Trả về true nếu điều khiển hiển thị; nếu không, trả về false.
getName() string Trả về tên của điều khiển.
getType() string | undefined Trả về kiểu điều khiển, chẳng MultiSelectPicklisthạn như undefined , hoặc khi loại không sẵn dùng. Xem Các loại điều khiển API máy khách.
getLogicalName() string | undefined Trả về tên lô-gic của điều khiển undefined hoặc khi tên lô-gic không sẵn dùng.
getValue() Khác nhau Truy xuất giá trị hiện tại. Loại trả về phụ thuộc vào loại điều khiển.
setDisabled(isDisabled: boolean) void Đặt trạng thái bị vô hiệu hóa của điều khiển.
setRequired(isRequired: boolean, errorMessage?: string) void Đặt trạng thái bắt buộc của điều khiển. Để biết thêm thông tin, hãy xem đặt Tham số phương pháp yêu cầu.
setVisible(isVisible: boolean) void Thiết lập khả năng hiển thị của điều khiển.
setValue(value) void Đặt giá trị mới. Loại giá trị dự kiến phụ thuộc vào loại điều khiển.
addValidator(id: string, evaluationFn: function, errorMessage: string) void Đăng ký trình xác thực phía máy khách tùy chỉnh trên phiên bản điều khiển này. Để biết thêm thông tin, hãy xem tham số phương pháp addValidator.
removeValidator(id: string) void Loại bỏ trình xác thực tùy chỉnh bằng ID của nó khỏi phiên bản điều khiển này. Không có gì khi ID không tồn tại.
clearValidators() void Loại bỏ tất cả các bộ xác thực tùy chỉnh được thêm vào phiên bản điều khiển này với addValidator. Điều này không ảnh hưởng đến trình xác thực bắt buộc quản setRequired lý.

setBắt buộc tham số phương pháp

Tham số Type Mô tả
isRequired boolean Xác định xem điều khiển có bắt buộc hay không.
errorMessage chuỗi (tùy chọn) Thông báo xác thực bản địa hóa. Mặc định là <field name> is a required field.

Khi isRequired đúng, API máy khách đăng ký trình xác thực chạy khi biểu mẫu được gửi. Khi sai, trình xác thực sẽ bị loại bỏ. Bạn không thể thực hiện điều khiển tùy chọn khi điều khiển được đánh dấu là bắt buộc trên máy chủ.

tham số phương pháp addValidator

Tham số Type Mô tả
id chuỗi Mã định danh duy nhất trên phiên bản điều khiển hiện tại. Trình xác thực mới có cùng ID sẽ thay thế bộ xác thực hiện có.
evaluationFn hàm Nhận giá trị điều khiển và trả về true khi giá trị hợp lệ.
errorMessage chuỗi Thông báo xuất hiện trong tóm tắt xác thực khi không xác thực được.

Quan trọng

Giữ và tái sử dụng cùng một đối Control tượng khi bạn thay thế hoặc loại bỏ bộ xác thực. Mỗi truy nhập vào form.controls và mỗi cuộc gọi để getControlByLogicalName trả về một mặt tiền điều khiển mới.

Nếu hàm đánh giá hoặc phương pháp getValue trả về lỗi, quá trình xác thực không thành công và bảng điều khiển trình duyệt ghi lại lỗi.

Microsoft.PowerPages.onPagesClientApiReady(async function ($pages) {
    const form = $pages.currentPage.forms.getFormById('form_#1');
    const control = form.getControlByLogicalName('new_keyword');

    control.setRequired(true, 'This field is mandatory.');
    control.addValidator(
        'keywordCheck',
        (value) => ['alpha', 'beta', 'gamma'].includes(value),
        'Value must be one of: alpha, beta, gamma.'
    );
});
  • Last updated on