Loại đ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.]

Bài viết này liệt kê các loại điều khiển được hỗ trợ. Tất cả các điều khiển đều có các phương pháp điều khiển phổ biến, nhưng một số phương pháp sử dụng các loại giá trị khác nhau và một số điều khiển có các thành viên bổ sung.

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.

Loại kiểm soát	Mô tả
Tổ hợp địa chỉ	Cung cấp các trường nhập địa chỉ với nhiều công ty con, chẳng hạn như đường phố, thành phố và tiểu bang.
Boolean	Cung cấp các trường nút chọn một với các tùy chọn đúng hoặc sai.
Ngày/giờ	Cung cấp trường đầu vào ngày và thời gian.
Thập phân	Cung cấp các trường nhập số thập phân.
Đôi	Cung cấp trường nhập số dấu chấm động.
Tra cứu thả xuống	Cung cấp danh sách thả xuống không theo chủ đề để chọn một bản ghi liên quan.
E-mail	Cung cấp trường nhập địa chỉ email.
Tệp	Cho phép người khác chọn tệp cho biểu mẫu có thể chỉnh sửa.
Số nguyên được định dạng	Cung cấp các trường số nguyên được định dạng như các giá trị như thời lượng, ngôn ngữ và múi giờ.
Họ và tên	Cung cấp các trường nhập tên với nhiều cấu phần, chẳng hạn như họ và tên.
Image	Cho phép ai đó chọn hình ảnh cho biểu mẫu có thể chỉnh sửa.
Số nguyên	Cung cấp trường đầu vào số nguyên.
Thông điệp	Cung cấp trường nhập văn bản nhiều dòng.
Tra cứu mô thức	Cung cấp hộp thoại mô thức để chọn một bản ghi liên quan.
Tiền	Cung cấp trường nhập tiền tệ.
Nhiều lựa chọn	Cung cấp trường hộp kiểm.
Danh sách chọn Nhiều Lựa chọn	Cung cấp các trường để chọn nhiều tùy chọn.
Danh sách chọn	Cung cấp các trường bộ tùy chọn, chẳng hạn như menu thả xuống và nút chọn một.
Trạng thái	Cung cấp trạng thái hiện tại của bản ghi bảng dưới dạng giá trị chỉ đọc.
Lý do trạng thái	Cung cấp lý do trạng thái hiện tại của bản ghi bảng dưới dạng giá trị chỉ đọc.
Chuỗi	Cung cấp trường nhập văn bản một dòng.
Biểu tượng chứng khoán	Cung cấp các trường nhập ký hiệu chứng khoán.
Địa chỉ URL	Cung cấp trường đầu vào URL.

Tổ hợp địa chỉ

Khắc phục các trường nhập liệu có chứa nhiều thành phần con, chẳng hạn như đường phố, thành phố và tiểu bang, hãy sử dụng điều khiển tổ hợp địa chỉ.

Địa chỉ các thuộc tính và phương pháp tổng hợp

Sử dụng các phần tử này để cấu hình và đọc các giá trị tổng hợp địa chỉ.

Phần tử	Loại	Mô tả
isReadOnly	Thuộc tính	Trả true về nếu trường ở dạng chỉ đọc, nếu không false.
setValue	Phương pháp	Xem tham số phương pháp setValue.
getValue	Phương pháp	Trả về cùng một đối tượng.

tham số phương pháp setValue

Dự kiến một đối tượng với các thuộc tính sau đây.

{
    "line1": "address line one value",
    "line2": "address line two value",
    "line3": "address line three value",
    "city": "address city value",
    "state": "address state value",
    "postalCode": "address postalCode value",
    "country": "address country value"
}

Boolean

Trường nút chọn một với tùy chọn true/false sử dụng điều khiển Boolean.

Thuộc tính và phương pháp Boolean

Sử dụng các thành viên này để đặt và truy xuất giá trị trường Boolean.

Phần tử	Loại	Mô tả
isReadOnly	Thuộc tính	Trả true về nếu trường ở dạng chỉ đọc, nếu không false.
setValue	Phương pháp	Dự kiến giá trị chuỗi tương ứng với các giá trị true hoặc false được bản địa hóa
getValue	Phương pháp	Trả về giá trị tùy chọn đã chọn dưới dạng chuỗi

Ngày/giờ

Trường đầu vào ngày và thời gian sử dụng điều khiển DateTime.

Thuộc tính và phương pháp DateTime

Sử dụng các thành viên này để quản lý và truy nhập các giá trị ngày và giờ.

Phần tử	Loại	Mô tả
isReadOnly	Thuộc tính	Trả true về nếu trường ở dạng chỉ đọc, nếu không false.
isDisabled	Thuộc tính	Trả true về nếu trường bị vô hiệu hóa, nếu không falsethì .
dataType	Thuộc tính	Kiểu dữ liệu của trường datetime
setValue	Phương pháp	Dự kiến chuỗi ngày giờ ở định dạng thích hợp
getValue	Phương pháp	Trả về giá trị datetime dưới dạng chuỗi.

Dấu thập phân

Trường nhập số thập phân sử dụng điều khiển Thập phân.

Thuộc tính thập phân và phương pháp

Dùng các phần tử này để làm việc với đầu vào số thập phân.

Phần tử	Loại	Mô tả
isReadOnly	Thuộc tính	Trả true về nếu trường ở dạng chỉ đọc, nếu không false.
setValue	Phương pháp	Dự kiến một chuỗi đại diện cho một số thập phân hợp lệ.
getValue	Phương pháp	Trả về giá trị thập phân dưới dạng chuỗi.

Kép

Trường nhập số dấu chấm động sử dụng điều khiển Đôi.

Thuộc tính và phương pháp kép

Sử dụng các phần tử này để xử lý các giá trị số dấu chấm động.

Phần tử	Loại	Mô tả
isReadOnly	Thuộc tính	Trả true về nếu trường ở dạng chỉ đọc, nếu không false.
setValue	Phương pháp	Dự kiến một chuỗi đại diện cho một số dấu chấm động hợp lệ.
getValue	Phương pháp	Trả về giá trị số dưới dạng chuỗi.

Tra cứu thả xuống

Điều khiển tra cứu không phải là phương thức sử dụng điều khiển tra cứu thả xuống.

Thuộc tính và phương pháp thả xuống

Sử dụng các thành viên này để tương tác với các lựa chọn tra cứu thả xuống.

Phần tử	Loại	Mô tả
isDropdown	Thuộc tính	Luôn luôn đúng. Sử dụng thuộc tính này để phân biệt giữa tra cứu mô thức và tra cứu thả xuống.
isReadOnly	Thuộc tính	Trả true về nếu trường ở dạng chỉ đọc, nếu không false.
setValue	Phương pháp	Dự kiến tham số chuỗi đại diện cho ID của tùy chọn để chọn.
getValue	Phương pháp	Trả về một đối tượng của biểu { id: string, name: string } mẫu cho tùy chọn đã chọn, hoặc không được xác định khi không có tùy chọn nào được chọn.

Email

Trường nhập email sử dụng điều khiển Email.

Thuộc tính và phương pháp email

Sử dụng các thành viên này để xác thực và truy xuất giá trị địa chỉ email.

Phần tử	Loại	Mô tả
isReadOnly	Thuộc tính	Trả true về nếu trường ở dạng chỉ đọc, nếu không false.
setValue	Phương pháp	Dự kiến một chuỗi đại diện cho một địa chỉ email hợp lệ.
getValue	Phương pháp	Trả về giá trị email dưới dạng chuỗi.

Tệp

Điều khiển Tệp cho phép ai đó chọn tệp cho biểu mẫu có thể chỉnh sửa.

Thuộc tính và phương pháp tệp

Sử dụng các thành viên này để chọn, truy nhập và xóa tệp.

Phần tử	Loại	Mô tả
isReadOnly	Thuộc tính	Trả true về nếu trường ở dạng chỉ đọc, nếu không false.
maxFileSizeInByte	Thuộc tính	Kích cỡ tối đa của tệp tính bằng byte mà bạn có thể tải lên.
setValue	Phương pháp	Dự kiến một đối tượng thuộc loại Tệp và đặt nó như thể ai đó đã chọn nó với bộ chọn tệp. Phương pháp trả về lỗi khi tệp trống hoặc vượt quá maxFileSizeInByte.
getValue	Phương pháp	Trả về đối tượng File mà bạn đã chọn hoặc đặt trong phiên biểu mẫu hiện tại. Nó không tải xuống một tệp đã được lưu trữ trong Dataverse.
removeFile	Phương pháp	Loại bỏ tệp đã đặt.

Để tải xuống tệp được lưu trữ trong cột tệp Dataverse, hãy sử dụng phương downloadFileFromColumn pháp này.

Số nguyên được định dạng

Trường số nguyên với các yêu cầu định dạng cụ thể như thời lượng, ngôn ngữ và múi giờ sử dụng điều khiển số nguyên đã định dạng.

Các phương pháp và thuộc tính số nguyên đã định dạng

Sử dụng các thành viên này để quản lý các số nguyên với định dạng chuyên biệt.

Phần tử	Loại	Mô tả
isReadOnly	Thuộc tính	Trả true về nếu trường ở dạng chỉ đọc, nếu không false.
setValue	Phương pháp	Dự kiến một chuỗi đại diện cho một số nguyên được định dạng hợp lệ.
getValue	Phương pháp	Trả về giá trị số nguyên đã định dạng dưới dạng một chuỗi.

Họ Tên

Đặt tên cho các trường đầu vào có thể chứa nhiều cấu phần (tên, họ, v.v.) sử dụng điều khiển tên đầy đủ.

Phương pháp tên đầy đủ

Sử dụng các phần tử này để cấu hình và đọc các cấu phần tên đầy đủ.

Phần tử	Loại	Mô tả
isReadOnly	Thuộc tính	Trả true về nếu trường ở dạng chỉ đọc, nếu không false.
setValue	Phương pháp	Dự kiến một đối tượng với các thuộc tính sau: { "firstName": "first name value", "middleName": "middle name value", "lastName": "last name value" }.
getValue	Phương pháp	Trả về cùng một đối tượng.

Ảnh

Điều khiển Hình ảnh cho phép ai đó chọn một hình ảnh cho biểu mẫu có thể chỉnh sửa.

Thuộc tính và phương pháp của hình ảnh

Sử dụng các thành viên này để chọn, truy nhập và xóa hình ảnh.

Phần tử	Loại	Mô tả
isReadOnly	Thuộc tính	Trả true về nếu trường ở dạng chỉ đọc, nếu không false.
maxFileSizeInByte	Thuộc tính	Kích cỡ tối đa của hình ảnh tính bằng byte mà bạn có thể tải lên.
setValue	Phương pháp	Mong đợi một hình ảnh của loại Tệp và đặt nó như thể ai đó đã chọn nó với bộ chọn tệp. Phương pháp trả về lỗi khi tệp trống, maxFileSizeInBytevượt quá hoặc không có kiểu MIME hình ảnh.
getValue	Phương pháp	Trả về đối tượng File mà bạn đã chọn hoặc đặt trong phiên biểu mẫu hiện tại. Nó không tải xuống một hình ảnh đã được lưu trữ trong Dataverse.
removeFile	Phương pháp	Loại bỏ ảnh tập hợp.

Để tải xuống hình ảnh được lưu trữ trong cột hình ảnh Dataverse, hãy sử dụng phương downloadFileFromColumn pháp này.

Số nguyên

Trường đầu vào dạng số sử dụng điều khiển Số nguyên.

Thuộc tính và phương pháp số nguyên

Sử dụng các phần tử này để đặt và truy xuất giá trị trường số nguyên.

Phần tử	Loại	Mô tả
isReadOnly	Thuộc tính	Trả true về nếu trường ở dạng chỉ đọc, nếu không false.
setValue	Phương pháp	Dự kiến một chuỗi đại diện cho một số nguyên hợp lệ.
getValue	Phương pháp	Trả về giá trị số nguyên dưới dạng chuỗi.

Thông điệp

Trường nhập văn bản nhiều dòng sử dụng điều khiển Bản ghi nhớ.

Thuộc tính và phương pháp ghi nhớ

Sử dụng các thành viên này để quản lý nội dung nhập văn bản nhiều dòng.

Phần tử	Loại	Mô tả
isReadOnly	Thuộc tính	Trả true về nếu trường ở dạng chỉ đọc, nếu không false.
setValue	Phương pháp	Kỳ vọng giá trị chuỗi. Phương pháp loại bỏ lỗi khi giá trị vượt quá độ dài tối đa đã lập cấu hình trường.
getValue	Phương pháp	Trả về văn bản bản ghi nhớ dưới dạng chuỗi.

Tra cứu mô thức

Trường tra cứu mô thức sử dụng điều khiển tra cứu mô thức.

Các thuộc tính và phương pháp tra cứu mô thức

Sử dụng các thành viên này để đặt, nhận và xóa các giá trị tra cứu theo phương thức.

Phần tử	Loại	Mô tả
isModal	Thuộc tính	Luôn true. Sử dụng thuộc tính này để phân biệt giữa tra cứu mô thức và tra cứu thả xuống.
isReadOnly	Thuộc tính	Trả true về nếu trường ở dạng chỉ đọc, nếu không false.
setValue	Phương pháp	Dự kiến một đối tượng có các thuộc tính sau: { "id": "Mã định danh duy nhất của bản ghi.", "name": "Giá trị trường tên chính của bản ghi", "entityType": "Giá trị tên kiểu thực thể của bảng." }
getValue	Phương pháp	Trả về cùng một đối tượng.
clearValue	Phương pháp	Xóa giá trị tập hợp khỏi trường.

Loại tiền

Trường nhập tiền tệ sử dụng điều khiển Tiền tệ.

Tài sản và phương pháp tiền

Sử dụng các thành viên này để đặt và truy xuất số tiền tệ.

Phần tử	Loại	Mô tả
readOnly	Thuộc tính	true nếu trường là trường chỉ đọc, nếu không falsethì .
setValue	Phương pháp	Dự kiến một chuỗi đại diện cho một số tiền hợp lệ.
getValue	Phương pháp	trả về giá trị tiền dưới dạng chuỗi.

Đa lựa chọn

Trường hộp kiểm sử dụng điều khiển đa lựa chọn.

Nhiều phương pháp lựa chọn

Sử dụng các phương pháp này để đặt và đọc trạng thái hộp kiểm.

Phần tử	Loại	Mô tả
setValue	Phương pháp	Kỳ vọng giá trị boolean.
getValue	Phương pháp	trả về trạng thái hộp kiểm dưới dạng boolean.

Danh sách chọn Nhiều Lựa chọn

Trường tùy chọn Chọn nhiều sử dụng điều khiển danh sách chọn Nhiều lựa chọn.

Phương pháp danh sách chọn nhiều Lựa chọn

Sử dụng các phương pháp này để đặt và đọc các tùy chọn đã chọn.

Phần tử	Loại	Mô tả
setValue	Phương pháp	Dự kiến một mảng các số đại diện cho các giá trị tùy chọn để chọn. Trả về lỗi nếu một giá trị không phải là một trong các tùy chọn sẵn có.
getValue	Phương pháp	Trả về các giá trị tùy chọn đã chọn dưới dạng mảng số.
setDisabled	Phương pháp	Không có hiệu lực khi biểu mẫu hoặc trường là chỉ đọc, vì điều khiển bị khóa trên máy chủ.

Ví dụ sau đây sẽ đọc và đặt các tùy chọn đã chọn.

Microsoft.PowerPages.onPagesClientApiReady(async function ($pages) {
    let form = $pages.currentPage.forms.getFormById('form_#1');
    let control = form && form.controls.find(c => c.getType() === 'MultiSelectPicklist');

    if (!control) {
        return;
    }

    // Get the selected values.
    let selectedValues = control.getValue(); // For example, [740740000, 740740001]

    // Set the selected values.
    control.setValue([740740000, 740740001]);
});

Danh sách chọn

Các trường bộ tùy chọn (menu thả xuống, nút chọn một, v.v.) sử dụng điều khiển Danh sách chọn.

Thuộc tính và phương pháp của danh sách chọn

Sử dụng các phần tử này để cấu hình và đọc các lựa chọn bộ tùy chọn.

Phần tử	Loại	Mô tả
subType	Thuộc tính	Loại con của điều khiển danh sách chọn. Các giá trị có thể là: VerticalRadioButton, HorizontalRadioButton, MultipleChoiceMatrixDropdown
setValue	Phương pháp	Dự kiến một chuỗi đại diện cho giá trị của tùy chọn để chọn.
getValue	Phương pháp	Trả về giá trị tùy chọn đã chọn dưới dạng chuỗi.

Trạng thái

Trạng thái hiện tại của bản ghi thực thể sử dụng điều khiển Trạng thái.

Lưu ý

Điều khiển này không cho phép đặt giá trị. Giá trị là chỉ đọc.

Lý do dẫn đến trạng thái

Lý do trạng thái hiện tại của bản ghi thực thể sử dụng điều khiển lý do trạng thái.

Lưu ý

Điều khiển này không cho phép đặt giá trị. Giá trị là chỉ đọc.

Chuỗi

Trường nhập văn bản sử dụng điều khiển Chuỗi.

Thuộc tính và phương pháp chuỗi

Sử dụng các phần tử này để quản lý các giá trị nhập văn bản một dòng.

Phần tử	Loại	Mô tả
isReadOnly	Thuộc tính	Trả true về nếu trường ở dạng chỉ đọc, nếu không false.
setValue	Phương pháp	Kỳ vọng giá trị chuỗi. Phương pháp loại bỏ lỗi khi giá trị vượt quá độ dài tối đa đã lập cấu hình trường.
getValue	Phương pháp	Trả về giá trị chuỗi.

Ký hiệu chứng khoán

Trường nhập ký hiệu chứng khoán sử dụng điều khiển ký hiệu chứng khoán.

Thuộc tính và phương pháp của ký hiệu chứng khoán

Sử dụng các thành viên này để đặt và truy xuất các ký hiệu chứng khoán.

Phần tử	Loại	Mô tả
isReadOnly	Thuộc tính	Trả true về nếu trường ở dạng chỉ đọc, nếu không false.
setValue	Phương pháp	Dự kiến một chuỗi đại diện cho ký hiệu chứng khoán hợp lệ.
getValue	Phương pháp	Trả về ký hiệu chứng khoán dưới dạng chuỗi.

URL

Trường đầu vào URL sử dụng điều khiển URL.

Thuộc tính và phương pháp URL

Sử dụng các thành viên này để xác thực và truy xuất các giá trị URL.

Phần tử	Loại	Mô tả
isReadOnly	Thuộc tính	Trả true về nếu trường ở dạng chỉ đọc, nếu không false.
setValue	Phương pháp	Dự kiến một chuỗi đại diện cho URL hợp lệ.
getValue	Phương pháp	Trả về giá trị URL dưới dạng chuỗi.

Thông tin liên quan

• Tổng quan về API máy khách
• Power Pages ví dụ về API Máy khách