~~Title: Efl.Ui.Format.format_string~~
====== Efl.Ui.Format.format_string ======

===== Description =====

%%A user-provided, string used to format the numerical value.%%

%%For example, "%1.2f meters", "%.0%%<nowiki>%%</nowiki>%%" or "%d items".%%

%%This is the simplest formatting mechanism, working pretty much like %%''printf''%%.%%

%%Different format specifiers (the character after the %) are available, depending on the %%''type''%% used. Use %%[[:develop:api:efl:ui:format_string_type|Efl.Ui.Format_String_Type.simple]]%% for simple numerical values and %%[[:develop:api:efl:ui:format_string_type|Efl.Ui.Format_String_Type.time]]%% for time and date values. For instance, %d means "integer" when the first type is used, but it means "day of the month as a decimal number" in the second.%%

%%Pass %%''NULL''%% to disable this mechanism.%%

//Since 1.23//
{{page>:develop:api-include:efl:ui:format:property:format_string:description&nouser&nolink&nodate}}

===== Values =====

  * **string** - %%Formatting string containing regular characters and format specifiers.%%
  * **type** - %%Type of formatting string, which controls how the different format specifiers are to be translated.%%

===== Signature =====

<code>
@property format_string {
    get {}
    set {}
    values {
        string: string;
        type: Efl.Ui.Format_String_Type (Efl.Ui.Format_String_Type.simple);
    }
}
</code>

===== C signature =====

<code c>
void efl_ui_format_string_get(const Eo *obj, const char **string, Efl_Ui_Format_String_Type *type);
void efl_ui_format_string_set(Eo *obj, const char *string, Efl_Ui_Format_String_Type type);
</code>

===== Implemented by =====

  * [[:develop:api:efl:ui:format:property:format_string|Efl.Ui.Format.format_string]]