Biểu mẫu, tab và mục 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.]

Sử dụng Power Pages mẫu API Máy khách, tab, phần và điều khiển để kiểm tra và quản lý các thành phần trang. Tham chiếu này giải thích về các tuyển tập, thuộc tính và phương pháp có sẵn để kiểm soát khả năng hiển thị, giá trị và dẫn hướng đa phương pháp.

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.

$pages.currentPage.forms

Bộ sưu $pages.currentPage.forms tập bao gồm các phương pháp để làm việc với các thành phần biểu mẫu trên trang.

$pages.currentPage.forms

Sử dụng các phương pháp này để liệt kê biểu mẫu và lấy các thể hiện biểu mẫu cụ thể.

Phương pháp Trả về Mô tả
getAll IForm[] Trả về tất cả các biểu mẫu được thêm vào trang hiện tại.
getFormById(id: string) IForm Truy xuất biểu mẫu bằng ID thành phần HTML của nó.
getFormByName(name: string) IForm Truy xuất biểu mẫu theo tên của nó.

$pages.currentPage.forms ví dụ về phương pháp

Những ví dụ này cho thấy cách nhận tất cả các biểu mẫu và truy xuất các biểu mẫu cụ thể theo ID hoặc tên.

Microsoft.PowerPages.onPagesClientApiReady(async function ($pages) {
    let forms = $pages.currentPage.forms.getAll();
    let form1 = $pages.currentPage.forms.getFormById('form_#1');
    let form2 = $pages.currentPage.forms.getFormByName('form_name')
});

Giao diện IForm

Giao diện IForm đại diện cho một bộ chứa cho các điều khiển và tab.

Thuộc tính IForm

Các thuộc tính sau đây mô tả biểu mẫu, các tab và điều khiển có trong biểu mẫu.

Thuộc tính Type Mô tả
id chuỗi ID của biểu mẫu.
name chuỗi Tên của biểu mẫu.
controls Điều khiển[] Tất cả điều khiển trên biểu mẫu.
tabs Tab[] Tất cả các tab trên biểu mẫu.
isMultiStep boolean True nếu biểu mẫu là multistep; nếu không, false. Xem Biểu mẫu nhiều người.

Phương pháp IForm

Sử dụng các phương pháp này để truy vấn khả năng hiển thị của biểu mẫu và chuyển đổi xem biểu mẫu có hiển thị hay không.

Phương pháp Trả về Mô tả
getVisible boolean Trả về true nếu có thể nhìn thấy biểu mẫu; nếu không, false.
setVisible(isVisible: boolean) void Đặt khả năng hiển thị của biểu mẫu.
getHtmlElement HTMLElement Trả về thành phần HTML cơ sở cho biểu mẫu.
getControlByLogicalName(logicalName: string) Điều khiển | undefined Trả về điều khiển trên biểu mẫu có tên lô-gic đã xác định, chẳng hạn như tên sơ đồ cột. Trả về không xác định khi không có điều khiển nào khớp.

Ví dụ về IForm

Ví dụ sau truy xuất biểu mẫu theo ID và ghi lại khả năng hiển thị, số lượng điều khiển và tab của biểu mẫu.

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

    console.log(`Form id: ${form.id} has ${form.controls.length} controls.`);

    if (form.getVisible()) {
        console.log('Form is currently visible.');
    }
    let tabs = form.tabs;
    console.log(`Form has ${tabs.length} tabs.`);

    // Look up a control by its logical name.
    let nameControl = form.getControlByLogicalName('fullname');
    if (nameControl) {
        nameControl.setValue('Jane Doe');
    }
});

Biểu mẫu nhiều bước

Biểu mẫu nhiều người là một bộ chứa chứa nhiều biểu mẫu cơ bản.

Thuộc tính biểu mẫu đa năng

Các thuộc tính sau đây áp dụng cho bộ chứa biểu mẫu đa năng và mô tả những gì sẵn dùng trong bước hiện hoạt.

Thuộc tính Type Mô tả
id chuỗi ID của biểu mẫu đa năng.
controls Điều khiển[] Tất cả các điều khiển trong bước hiện tại.
tabs Tab[] Tất cả các tab trong bước hiện tại.
isMultiStep boolean True nếu biểu mẫu là multistep; nếu không, false.
nextButton Thành phần JQuery Đại diện cho nút tiếp theo (đối tượng trống nếu vắng mặt).
previousButton Thành phần JQuery Đại diện cho nút trước đó (đối tượng trống nếu vắng mặt).

Phương pháp biểu mẫu nhiều người

Sử dụng các phương pháp này để kiểm tra khả năng hiển thị và di chuyển giữa các bước trong biểu mẫu nhiều người.

Tên Trả về Mô tả
getVisible boolean Trả về true nếu có thể nhìn thấy biểu mẫu; nếu không, false.
setVisible(isVisible: boolean) void Đặt khả năng hiển thị của biểu mẫu.
hasNextStep boolean Trả về true nếu tồn tại bước tiếp theo; nếu không, false.
hasPreviousStep boolean Trả về true nếu tồn tại bước trước đó; nếu không, false.
goToNextStep void Dẫn hướng đến bước tiếp theo; nộp biểu mẫu nếu không có bước tiếp theo nào tồn tại.
goToPreviousStep void Dẫn hướng đến bước trước đó; trả về một ngoại lệ nếu không có ngoại lệ nào tồn tại.
getControlByLogicalName(logicalName: string) Điều khiển | undefined Trả về điều khiển trong bước hiện tại có tên lô-gic đã xác định, chẳng hạn như tên sơ đồ cột. Trả về không xác định khi không có điều khiển nào khớp.

Ví dụ về biểu mẫu đa năng

Ví dụ này cho thấy cách truy xuất biểu mẫu nhiều lần, kiểm tra biểu mẫu và chuyển sang bước tiếp theo.

Microsoft.PowerPages.onPagesClientApiReady(async function ($pages) {
    let form = $pages.currentPage.forms.getFormById('multiform_#1');
    console.log(`Form id: ${form.id} has ${form.controls.length} controls.`);

    if (form.getVisible()) {
        console.log('Form is currently visible.');
    }

    let tabs = form.tabs;
    console.log(`Form has ${tabs.length} tabs.`);

    form.goToNextStep();
});

Tab

A Tab chứa một hoặc nhiều phần trong một biểu mẫu.

Thuộc tính Sections Tab

Một mảng các phần trong tab.

Phương pháp tab

Sử dụng các phương pháp này để kiểm tra khả năng hiển thị của tab, truy xuất tên của tab và chuyển đổi xem tab có hiển thị hay không.

Phương pháp Trả về Mô tả
getVisible boolean Trả về true nếu tab hiển thị; nếu không, false.
getName string Trả về tên của tab.
setVisible(isVisible: boolean) void Đặt khả năng hiển thị của tab.

Ví dụ về tab

Ví dụ này truy xuất biểu mẫu, liệt kê các tab của biểu mẫu và ghi lại tên của tab đầu tiên.

Microsoft.PowerPages.onPagesClientApiReady(async function ($pages) {
    let form = $pages.currentPage.forms.getFormById('form_#1');
    let tabs = form.tabs;
    console.log(`Form has ${tabs.length} tabs.`);
    console.log(`First tab is named: ${tabs[0].getName()}`);
});

Phần

Các điều khiển nhóm Phần trong một tab.

Thuộc tính Controls Section

Một mảng các điều khiển trong phần.

Phương pháp phần

Sử dụng các phương pháp này để đọc tên của một phần và kiểm soát khả năng hiển thị của nó.

Phương pháp Trả về Mô tả
getVisible boolean Trả về true nếu phần đó hiển thị; nếu không, false.
getName string Trả về tên phần.
setVisible(isVisible: boolean) void Đặt khả năng hiển thị của phần.

Ví dụ về phần

Ví dụ này truy xuất các phần từ tab đầu tiên của biểu mẫu và ghi lại các chi tiết cơ bản.

Microsoft.PowerPages.onPagesClientApiReady(async function ($pages) {
    let form = $pages.currentPage.forms.getFormById('form_#1');
    let sections = form.tabs[0].sections;
    console.log(`Tab has ${sections.length} section(s).`);
    console.log(`First section is named: ${sections[0].getName()}`);
});

Điều khiển

A đại Control diện cho một thành phần biểu mẫu riêng lẻ. Sử dụng các phương pháp điều khiển phổ biến để truy xuất hoặc cập nhật giá trị, khả năng hiển thị, trạng thái bắt buộc và trạng thái bị vô hiệu hóa cũng như để thêm xác thực phía máy khách. Các loại giá trị và phần tử bổ sung phụ thuộc vào loại điều khiển.

  • Last updated on