Power Pages 클라이언트 API 컨트롤은 양식 값, 상태, 표시 유형, 요구 사항 및 유효성 검사를 관리하기 위한 일반적인 메서드를 제공하는 인터페이스를 구현 Control 합니다. 이 참조를 사용하여 사용 가능한 메서드 및 반환 형식을 식별합니다. 컨트롤별 값 형식 및 추가 멤버는 클라이언트 API 컨트롤 형식을 참조하세요.
| 메서드 | Returns | Description |
|---|---|---|
getDisabled() |
boolean |
컨트롤을 사용할 수 없으면 반환 true 하고, 그렇지 않으면 반환합니다 false. |
getRequired() |
boolean |
컨트롤이 필요한 경우 반환 true 하고, 그렇지 않으면 반환합니다 false. |
getVisible() |
boolean |
컨트롤이 표시되면 반환 true 하고, 그렇지 않으면 반환합니다 false. |
getName() |
string |
컨트롤의 이름을 반환합니다. |
getType() |
string | undefined |
컨트롤 형식(예: MultiSelectPicklist또는 undefined 형식을 사용할 수 없는 경우)을 반환합니다.
클라이언트 API 컨트롤 형식을 참조하세요. |
getLogicalName() |
string | undefined |
컨트롤의 논리적 이름 또는 undefined 논리 이름을 사용할 수 없는 경우를 반환합니다. |
getValue() |
Varies | 현재 값을 검색합니다. 반환 형식은 컨트롤 형식에 따라 달라집니다. |
setDisabled(isDisabled: boolean) |
void |
컨트롤의 비활성 상태를 설정합니다. |
setRequired(isRequired: boolean, errorMessage?: string) |
void |
컨트롤의 필수 상태를 설정합니다. 자세한 내용은 setRequired 메서드 매개 변수를 참조하세요. |
setVisible(isVisible: boolean) |
void |
컨트롤의 표시 유형을 설정합니다. |
setValue(value) |
void |
새 값을 설정합니다. 예상 값 형식은 컨트롤 형식에 따라 달라집니다. |
addValidator(id: string, evaluationFn: function, errorMessage: string) |
void |
이 컨트롤 인스턴스에 사용자 지정 클라이언트 쪽 유효성 검사기를 등록합니다. 자세한 내용은 addValidator 메서드 매개 변수를 참조하세요. |
removeValidator(id: string) |
void |
이 컨트롤 인스턴스에서 ID로 사용자 지정 유효성 검사기를 제거합니다. ID가 없을 때는 아무 작업도 수행하지 않습니다. |
clearValidators() |
void |
를 사용하여 이 컨트롤 인스턴스 addValidator에 추가된 모든 사용자 지정 유효성 검사기를 제거합니다. 관리하는 필수 유효성 검사기에 setRequired 는 영향을 주지 않습니다. |
setRequired 메서드 매개 변수
| 매개 변수 | Type | Description |
|---|---|---|
isRequired |
부울 | 컨트롤이 필요한지 여부를 지정합니다. |
errorMessage |
문자열(선택 사항) | 지역화된 유효성 검사 메시지입니다. 기본값은 <field name> is a required field.입니다. |
true인 경우 isRequired 클라이언트 API는 양식이 제출될 때 실행되는 유효성 검사기를 등록합니다. false이면 유효성 검사기가 제거됩니다. 서버에서 필요에 따라 표시된 경우 컨트롤을 선택적으로 만들 수 없습니다.
addValidator 메서드 매개 변수
| 매개 변수 | Type | Description |
|---|---|---|
id |
string | 현재 컨트롤 인스턴스의 고유 식별자입니다. ID가 동일한 새 유효성 검사기가 기존 유효성 검사기를 대체합니다. |
evaluationFn |
기능 | 컨트롤 값을 받고 값이 유효한 경우 true를 반환합니다. |
errorMessage |
string | 유효성 검사에 실패할 때 유효성 검사 요약에 표시되는 메시지입니다. |
Important
유효성 검사기를 바꾸거나 제거할 때 동일한 Control 개체 인스턴스를 유지하고 다시 사용합니다. 각 액세스 form.controls 권한과 새 컨트롤 외관을 반환하는 getControlByLogicalName 각 호출입니다.
평가 함수 또는 메서드가 getValue 오류를 throw하는 경우 유효성 검사가 실패하고 브라우저 콘솔에서 오류를 기록합니다.
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.'
);
});