郵便番号コントロールの基本的な使用方法について解説します。
JPAddress for ASP.NETの準備
郵便番号コントロールの機能は、「JPAddress for ASP.NET（以下、JPAddress）」を利用して実現されており、検索機能を利用するためにはJPAddressのインストールが必要です。また、検索機能を使用するためには、JPAddressのGcJPAddressコンポーネントをページに配置する必要があります。
詳細については「JPAddress for .NETとの連携」を参照してください。
詳細については「JPAddress for .NETとの連携」を参照してください。
書式の設定
郵便番号コントロールの書式を設定するには、Formatプロパティが参照するPostalFormatオブジェクトを使用します。PostalFormatクラスの以下のプロパティを設定することで郵便番号用の書式を作成します。
| PostalFormatのプロパティ | 説明 |
|---|---|
 ZipCodePrefix |
接頭語を定義します。 |
| ZipCodeSeparator |
3桁と4桁を区切る記号を定義します。 |
また、ZipCodeCharTypeプロパティを使用すると、入力可能な郵便番号用数値を全角か半角かのとちらかに限定することができます。 既定値はZipCodeCharType.HalfWidthDigitです。
| ZipCodeCharTypeの値 | 説明 |
|---|---|
| HalfWidthDigit | 入力文字を半角に限定します。 |
| FullWidthDigit | 入力文字を全角に限定します。 |
次のサンプルコードは、郵便番号コントロールの書式を設定し、郵便番号は全角に限定します。
Imports GrapeCity.Web.Input.IMPostal ' 郵便番号の書式を設定します。 GcPostal1.Format.ZipCodePrefix = "〒" GcPostal1.Format.ZipCodeSeparator = "−" ' 郵便番号を全角で表示します。 GcPostal1.ZipCodeCharType = ZipCodeCharType.FullWidthDigit
using GrapeCity.Web.Input.IMPostal; // 郵便番号の書式を設定します。 GcPostal1.Format.ZipCodePrefix = "〒"; GcPostal1.Format.ZipCodeSeparator = "−"; // 郵便番号を全角で表示します。 GcPostal1.ZipCodeCharType = ZipCodeCharType.FullWidthDigit;
また、次のサンプルコードは上記と同じ設定をPostalFormatオブジェクトを明示的に生成することで行います。
Imports GrapeCity.Web.Input.IMPostal ' 郵便番号の書式を設定します。 GcPostal1.Format = New PostalFormat("〒", "−") ' 郵便番号を全角で表示します。 GcPostal1.ZipCodeCharType = ZipCodeCharType.FullWidthDigit
using GrapeCity.Web.Input.IMPostal; // 郵便番号の書式を設定します。 GcPostal1.Format = new PostalFormat("〒", "−"); // 郵便番号を全角で表示します。 GcPostal1.ZipCodeCharType = ZipCodeCharType.FullWidthDigit;
検索の対象と出力用コントロール
郵便番号コントロールは入力された郵便番号から住所などの検索を行い、検索結果を指定したコントロールに出力します。QueryModeプロパティで住所の郵便番号と大口事業所の個別郵便番号、もしくはその両方を対象として検索を行うかどうかを設定できます。 既定値はZipCodeQueryMode.GeneralZipCodeです。
| ZipCodeQueryModeの値 | 説明 |
|---|---|
| GeneralZipCode | 住所の郵便番号を対象に検索を行います。 |
| CompanyZipCode | 大口事業所の個別郵便番号を対象に検索を行います。 |
| Both | 住所の郵便番号と大口事業所の個別郵便番号の両方を対象に検索を行います。 |
また、検索結果を出力するコントロールは以下のプロパティで設定します。
| プロパティ名 | 説明 |
|---|---|
| AddressOutput |
検索結果の「住所」を出力するコントロールのIDを取得または設定します。 |
| AddressKanaOutput |
検索結果の「住所（フリガナ）」を出力するコントロールのIDを取得または設定します。 |
次のサンプルコードは、郵便番号を入力したときの検索結果をGcTextBox1およびGcTextBox2に出力します。
Imports GrapeCity.Web.Input.IMExtenders ' 住所の郵便番号データと大口事業所の個別番号データの両方を検索します。 GcPostal1.QueryMode = ZipCodeQueryMode.Both ' 検索された住所の漢字情報が出力されるコントロール（GcTextBox1）を指定します。 GcPostal1.AddressOutput = GcTextBox1.ID ' 検索された住所のふりがな情報が出力されるコントロール（GcTextBox2）を指定します。 GcPostal1.AddressKanaOutput = GcTextBox2.ID
using GrapeCity.Web.Input.IMExtenders; // 住所の郵便番号データと大口事業所の個別番号データの両方を検索します。 GcPostal1.QueryMode = ZipCodeQueryMode.Both; // 検索された住所の漢字情報が出力されるコントロール（GcTextBox1）を指定します。 GcPostal1.AddressOutput = GcTextBox1.ID; // 検索された住所のふりがな情報が出力されるコントロール（GcTextBox2）を指定します。 GcPostal1.AddressKanaOutput = GcTextBox2.ID;
検索結果のカスタマイズ
郵便番号から検索される住所などの情報は、次の2つのプロパティによって結果をカスタマイズできます。
郵便番号によっては、ひとつの郵便番号に複数の丁目が含まれている場合があります。こういった場合に、それぞれを分割して別々のレコードとするか、複数の丁目がまとまったままのひとつのレコードとするかを設定します。
たとえば、〒105-0022は「東京都港区海岸（１、２丁目）」と登録されています。これを
大口事業所の個別郵便番号の検索結果にのみ有効です。住所の郵便番号の場合には住所のカナは必ず含まれます。
SplitAreaDetailsプロパティ
同じ郵便番号に複数の丁目が含まれているときにそれぞれを分割するかどうかを取得または設定します。郵便番号によっては、ひとつの郵便番号に複数の丁目が含まれている場合があります。こういった場合に、それぞれを分割して別々のレコードとするか、複数の丁目がまとまったままのひとつのレコードとするかを設定します。
たとえば、〒105-0022は「東京都港区海岸（１、２丁目）」と登録されています。これを
- 東京都港区海岸１丁目
- 東京都港区海岸２丁目
- 東京都港区海岸（１、２丁目）
 |
SplitAreaDetails プロパティをTrue に設定してそれぞれを別々のレコードとして扱った場合、分割した最初のレコードが検索結果として返されます。 |
GenerateCompanyAddressKanaプロパティ
大口事業所の検索結果に住所のカナを含めるかどうかを取得または設定します。大口事業所の個別郵便番号の検索結果にのみ有効です。住所の郵便番号の場合には住所のカナは必ず含まれます。
関連トピック