VBA関数のFormat関数

Format関数は、VBA関数の中で文字列操作関数に分類される関数です。

目次

• Format関数とは
• Format関数のサンプルコード
  • 実行結果
  • 解説

Format関数とは

Format関数は、式を指定した書式に変換し、その文字列を示すバリアント型 (内部処理形式 String の Variant) の値を返します。

引数firstdayofweek

引数firstweekofyear

対象形式

引数 format を省略して数値に書式を設定しようとすると、Format 関数は Str 関数を呼び出した場合と同様の結果を返します。Format 関数の返す値は国別情報に対応しています。ただし、Str 関数を使用して正の数値を文字列に変換した場合、符号用のスペースが先頭に付加されますが、Format 関数を使用した場合、このスペースは付加されません。

ローカライズされていない数値文字列を書式設定する場合、目的の書式設定を確実に行うことができるように数値表示書式指定文字を使用するようにしてください。

Calendar プロパティの設定がグレゴリオ暦の場合で、引数 format で日付書式を使用するように指定した場合、引数 expression にはグレゴリオ暦で表される日付を指定する必要があります。Calendar プロパティの設定が回教暦の場合で、引数 format で日付書式を使用するように指定した場合、引数 expression には回教暦で表される日付を指定する必要があります。

Calendar プロパティの設定がグレゴリオ暦の場合、引数 format で指定する表示書式指定文字は、通常の場合と同じ意味になります。Calendar プロパティの設定が回教暦の場合、引数 format で指定する表示書式指定文字 (たとえば、dddd、mmmm、yyyy) は、グレゴリオ暦の場合と同じ意味になりますが、設定される対象は回教暦のカレンダーになります。また、表示書式指定文字自体は英語のままとなりますが、表示結果は表示書式指定文字に応じて適切なアラビア語が使用されます。さらに、表示書式指定文字で表される値の範囲が、次の表に示すようにグレゴリオ暦の場合と比べて変わる場合があります。

表示書式指定文字

Format関数のサンプルコード

次の例は、Format 関数を使って、定義済み書式やユーザー定義の書式に従って、各種の値を変換します。日付の区切り記号 (/)、時刻の区切り記号 (:)、AM/PM リテラルの変換後の書式は、実行時のシステムの国別情報の設定によって異なります。開発環境で日付と時刻が表示されるときには、コード記述時の国別情報で指定されている日付と時刻の短い形式が使われます。実行時に日付と時刻が表示されるときは、オペレーティング システムの国別情報で指定されている日付と時刻の短い形式が使われます。したがって、実行時に表示される形式は、コード記述時の国別情報の設定とは異なる場合があります。次の例では、国別情報で [英語/アメリカ] が設定されていることを前提としています。
変数 MyTime と変数 MyDate を開発環境で表示すると、現在のシステムで設定されている日付と時刻の短い形式が使われます。

Sub sample()

 Dim MyTime, MyDate, MyStr
 MyTime = #17:04:23#
 MyDate = #January 27, 1993#

 ' システムで定義されている時刻の長い形式を使って、システムの現在の時刻を返します。
 MyStr = Format(Time, "Long Time")

 ' システムで定義されている日付の長い形式を使って、システムの現在の日付を返します。
 MyStr = Format(Date, "Long Date")

 MyStr = Format(MyTime, "h:m:s")            ' "17:4:23" を返します。
 MyStr = Format(MyTime, "hh:mm:ss AMPM")    ' "05:04:23 PM" を返します。
 MyStr = Format(MyDate, "dddd, mmm d yyyy")    ' "Wednesday,Jan 27 1993" を返します。
 ' 書式を指定しない場合は文字列を返します。
 MyStr = Format(23)                    ' "23" を返します。

 ' ユーザー定義の書式。
 MyStr = Format(5459.4, "##,##0.00")        ' "5,459.40" を返します。
 MyStr = Format(334.9, "###0.00")            ' "334.90" を返します。
 MyStr = Format(5, "0.00%")            ' "500.00%" を返します。
 MyStr = Format("HELLO", "<")            ' "hello" を返します。
 MyStr = Format("This is it", ">")        ' "THIS IS IT" を返します。

End Sub

実行結果

解説

文字列操作関数一覧