Інструкція з використання Rename Us vlsoftware.net

Функції, доступні у виразах

Contents Index Previous Next

Движок виразів Rename Us дозволяє виконувати Pascal-подібні вирази, які можуть використовуватися в діях по перейменуванню.

Вирази можуть складатися з функцій (дозволяються вкладення будь-якої глибини), арифметичних і логічних операторів та літералів (числових, строчкових або булевських). Вираз повертає одне значення числового, строчкового або булевського типу.

Зауваження

1. Назви функцій та операторів не залежні від регістру символів.

2. Параметри параметризованих функцій можуть бути як константами (літералами), так і виразами.

3. Строчкові літерали повинні братися в одинарні лапки. Якщо літерал містить одинарні лапки всередині, кожен з них повинен бути продубльований.

4. Багатострочкові літерали не дозволяються. Якщо потрібно передати великий текст в якості параметра, розбийте його на невеликі окремі строчки та з'єднайте їх за допомогою оператора +.

Функції

Функції, що відносяться до поточного файлу в черзі

<CURRENT_NAME> Повертає поточну назву. Для першої дії в списку дій це буде назва файлу (або розширення). Для інших дій це буде результат попередньої дії.
<FILE_PATH> Повертає повний шлях.
<FILENO> Повертає номер файлу в списку файлів проекту.
<INITIAL_NAME> Повертає початкову назву файлу або розширення (тобто те, що було до першої дії).
<MP3TAG_ALBUM> Повертає вміст тегу Назва альбому MP3-файлу (лише для файлів, що мають розширення .mp3 або .ape).
<MP3TAG_ARTIST> Повертає вміст тегу Виконавець MP3-файлу (лише для файлів, що мають розширення .mp3 або .ape).
<MP3TAG_COMMENT> Повертає вміст тегу Коментар MP3-файлу (лише для файлів, що мають розширення .mp3 або .ape).
<MP3TAG_COMPOSER> Повертає вміст тегу Композитор MP3-файлу (лише для файлів, що мають розширення .mp3 або .ape).
<MP3TAG_COPYRIGHT> Повертає вміст тегу Авторські права MP3-файлу (лише для файлів, що мають розширення .mp3 або .ape).
<MP3TAG_ENCODER> Повертає вміст тегу Кодувальник MP3-файлу (лише для файлів, що мають розширення .mp3 або .ape).
<MP3TAG_GENRE> Повертає вміст тегу Жанр MP3-файлу (лише для файлів, що мають розширення .mp3 або .ape).
<MP3TAG_TITLE> Повертає вміст тегу Назва треку MP3-файлу (лише для файлів, що мають розширення .mp3 або .ape).
<MP3TAG_TRACK> Повертає вміст тегу № треку MP3-файлу (лише для файлів, що мають розширення .mp3 або .ape).
<MP3TAG_URL> Повертає вміст тегу URL MP3-файлу (лише для файлів, що мають розширення .mp3 або .ape).
<MP3TAG_YEAR> Повертає вміст тегу Рік MP3-файлу (лише для файлів, що мають розширення .mp3 або .ape).

Математичні

abs( x Numeric ): Numeric Повертає абсолютне значення числа x
frac( x Numeric ): Numeric Повертає дрібну частину числа x
int( x Numeric ): Numeric Повертає цілу частину числа x
round( x Numeric ): Numeric Повертає значення числа x, округлене до найближчого цілого
sqrt( x Numeric ): Numeric Повертає квадратний корінь з числа x
power( x Numeric, y Numeric ): Numeric Зводить число x до степеня y
exp( x Numeric ): Numeric Повертає експоненту числа x
ln( x Numeric ): Numeric Повертає натуральний логарифм числа x
cos( x Numeric ): Numeric Повертає косинус x, де x задається в радіанах
sin( x Numeric ): Numeric Повертає синус x, де x задається в радіанах
tan( x Numeric ): Numeric Повертає тангенс x, де x задається в радіанах
atan( x Numeric ): Numeric Повертає арктангенс x, тобто значення, чий тангенс дорівнює x

Дата і час

date: Date Повертає поточну дату
time: Time Повертає поточний час
add_date_time( x DateTime, y Numeric ): DateTime Додає y днів до дати/часу x. y може бути цілим або дійсним числом, наприклад, 2.5 означає 2 дні та 12 годин.
compare_date_time( Date1 DateTime, Date2 Numeric ): Numeric Повератє ціле число, що показує результат порівняння дати/часу Date1 та дати/часу Date2: 0, якщо Date1 = Date2; 1, якщо Date1 > Date2; -1, якщо Date1 < Date2.
date_time_diff( Date1 DateTime, Date2 DateTime ): Numeric Повертає різницю в днях (як дійсне число) між датою/часом Date1 та датою/часом Date2
format_date_time( x DateTime, Mask String ): String Форматує дату/час x, використовуючи маску Mask. Наприклад, для відображення лише поточного місяця, можна використовувати date в якості першого параметра та 'm' або 'mmmm' в якості другого.

Пов'язані з файлами

file_created( FileName String ): DateTime Повертає дату і час, коли файл FileName було створено. В FileName повинен передаватися повний шлях.
file_last_modified( FileName String ): DateTime Повертає дату і час, коли файл FileName було востаннє модифіковано. В FileName повинен передаватися повний шлях.
file_last_accessed( FileName String ): DateTime Повертає дату і час, коли файл FileName востаннє відкривався. В FileName повинен передаватися повний шлях.
file_size( FileName String ): Numeric Повертає розмір файлу FileName в байтах. В FileName повинен передаватися повний шлях.
file_version( FileName String ): Numeric Повертає версію файлу FileName. В FileName повинен передаватися повний шлях.
extract_file_ext( FileName String ): String Витягує розширення файлу FileName (з крапкою)
extract_file_name( FileName String ): String Витягує назву файлу з повного шляху FileName
extract_file_dir( FileName String ): String Витягує шлях до файлу (без символу \ в кінці) з повного шляху FileName
extract_file_path( FileName String ): String Витягує шлях до файлу (з символом \ в кінці) з повного шляху FileName
extract_file_text( FileName String ): String Витягує текст з текстового файлу FileName. В FileName повинен передаватися повний шлях.
file_exists( FileName String ): Boolean Повертає True, якщо файл FileName існує, і False в іншому випадку
dir_exists( DirectoryName String ): Boolean Повертає True, якщо директорія DirectoryName існує, і False в іншому випадку

Різне

to_number( x <AnyType> ): Numeric Перетворює x в число
to_string( x <AnyType> ): String Перетворює x в строчку (текст)
format_float( x Numeric, Mask String ): String Форматує число x, використовуючи маску Mask. Наприклад, щоб завжди відображувати дві цифри після десяткової точки, використовуйте '0.00' в якості другого параметра.
lpad( Str String, Count Numeric, Char String ): String Додає символи Char до строчки Str зліва. Count - кількість результуючих символів.
rpad( Str String, Count Numeric, Char String ): String Додає символи Char до строчки Str справа. Count - кількість результуючих символів.
iif( Condition Boolean, x <AnyType>, y <AnyType> ): <AnyType> Повертає x, якщо умова Condition дає True, або y в інакшому випадку
upper( Str String ): String Перетворює строчку Str до верхнього регістру
lower( Str String ): String Перетворює строчку Str до нижнього регістру
capitalize( Str String ): String Перетворює перші символи кожного слова строчці Str до верхнього регістру
pretty( Str String ): String Перетворює перший символ строчки Str до верхнього регістру, а всі інші - до нижнього
length( Str String ): Integer Повертає довжину (кількість символів) строчки Str
pos( SubStr String, Str String ): Integer Повертає позицію підстрочки SubStr в строчці Str
substr( Str String, Index Integer, Count Integer ): String Повертає підстрочку строчки Str, яка містить Count символів, починаючи з позиції Index
substr_count( Str String, SubStr String ): Integer Повертає кількість входжень підстрочки SubStr в строчці Str
trim( Str String ): String Відсікає ведучі та кінцеві пробіли і керуючі символи з строчки Str
trim_left( Str String ): String Відсікає ведучі пробіли і керуючі символи з строчки Str
trim_right( Str String ): String Відсікає кінцеві пробіли і керуючі символи з строчки Str
string_replace( Str String, SubStr Integer, NewSubStr Integer ): String Замінює всі підстрочки SubStr в тексті Str на NewSubStr
concat( Str1 String, Str2 Integer ): String Повертає строчку, що є результатом конкатенації строчок Str1 та Str2
ordinal_number( x Integer, Language String, Case Integer, Gender Integer ): String

Порядковий номер. Повертає оригінальне число і порядкове закінчення цілого x.

Language - мова, якою повинен бути представлений результат. Можливі значення: 'en-US' (American English), 'uk-UA' (Ukrainian).

Case - відмінок. Можливі значення: від 'A' да 'F' ('A' - називний, 'B' - родовий і т.д.).

Gender - рід. Можливі значення: 'M' (чоловічий), 'F' (жіночий), 'N' (середній).

Наприклад, ORDINALNUMBER(5, 'B', 'F') поверне 5-ї (тобто скорочене від "п'ятої").

quantitative_numeral( x Integer, Language String, Case Integer, Gender Integer ): String

Кількісний числівник. Повертає оригінальне число і кількісне закінчення для цілого x.

Language - мова, якою повинен бути представлений результат. Можливі значення: 'uk-UA' (Ukrainian).

Case - відмінок. Можливі значення: від 'A' да 'F' ('A' - називний, 'B' - родовий і т.д.).

Gender - рід. Можливі значення: 'M' (чоловічий), 'F' (жіночий), 'N' (середній).

Наприклад, ORDINALNUMBER(3, F, F) поверне 3-х (тобто скорочене від "трьох").

number_to_words( x Numeric, Language String, Options String ): String

Конвертує число x в його еквівалент прописом.

Language - мова, якою повинен бути представлений результат. Можливі значення: 'en-US' (American English), 'uk-UA' (Ukrainian).

Options - набір опцій, розділених символом |, кожна з яких записується у форматі OptionName=OptionValue.
Доступні опції:
- ShowZeroSubunits. Вказує, чи потрібно виводити дрібну частину, якщо вона дорівнює нулю. Можливі значення: True або False. Значення по замовчанню: False.
- ProcessSubunits. Вказує, чи потрібно перетворювати і дрібну частину в слова. Можливі значення: True або False. Значення по замовчанню: False.
- UnitsSubunitsSeparator. Вказує розділювач цілої та дрібної частини числа. Значення по замовчанню: пробіл.
- SubunitsDimension. Розмірність для дрібної частини числа. Значення по замовчанню: 2. Ця опція ігнорується, якщо ProcessSubunits дорівнює True.
- CurrencyCode. Вказує код валюти в форматі ISO 4217. Зараз підтримуються лише наступні коди валют: USD, EUR, UAH. Використання даної опції вказує інтерпретувати число як значення валюти і додавати назви валюти.
- Type. Вказує тип перетворення. Можливі значення: regular, fraction. У останньому випадку результат буде виглядати, наприклад, як ... цілих ... тисячних. Ця опція має значення лише якщо Language дорівнює 'uk-UA'.
- UnitsShortened. Вказує вживати скорочену назву основної одиниці валюти, якщо вона використовується (тобто, наприклад, грн. замість гривень). Ця опція має значення лише якщо Language дорівнює 'uk-UA'.
- SubunitsShortened. Вказує вживати скорочену назву розмінної одиниці валюти, якщо вона використовується (тобто, наприклад, коп. замість копійок). Ця опція має значення лише якщо Language дорівнює 'uk-UA'.

Приклади:

Вираз Результат
number_to_words( dataset_field_val(1, 'pay_sum'), 'uk-UA', 'UnitsSubunitsSeparator= and |CurrencyCode=UAH|SubunitsDimension=2|ShowZeroSubunits=true' )  
number_to_words( 3467.35, 'uk-UA', 'UnitsSubunitsSeparator= та |CurrencyCode=UAH|ShowZeroSubunits=true' ) три тисячі чотириста шістдесят сім гривень та 35 копійок
number_to_words( 3467.35, 'uk-UA', 'SubunitsDimension=4|ShowZeroSubunits=true' ) три тисячі чотириста шістдесят сім 3500
remove_digits( Str String ): String Видаляє цифрові символи зі строчки Str
digits_only( Str String ): String Видаляє нецифрові символи зі строчки Str