ITemplateSubstitutionService սերվիս

Բովանդակություն

Ներածություն
Մեթոդներ

Ներածություն

ITemplateSubstitutionService դասը նախատեսված է տպելու ձևանմուշների լրացման հետ աշխատանքը ապահովելու համար։

Այս դասը օգտագործվում է այն դեպքերում, երբ հարկավոր է տպելու ձևանմուշ լրացնել ոչ կոնկրետ փաստաթղթի համար. օրինակ՝ քաղվածքի ձևավորում, ծանուցման ձևավորում, էլ.նամակի տեքստի ձևավորում։

Տե՛ս նաև TemplateService տպելու ձևանմուշների հետ աշխատանքի համար։

Տե՛ս օրինակը։

Մեթոդներ

EvalAndAddUserDefinedParameters

public Task EvalAndAddUserDefinedParameters(
    string name, SubstitutionType type,
    PrintTemplateSubstitution printTemplateSubstitution,
    Document.Document document)

Հաշվարկում է տպելու ձևանմուշի օգտագործողի կողմից նկարագրված պարամետրերը և ավելացնում տպելու ձևանմուշի տեղադրվող արժեքները պարունակող օբյեկտում՝ printTemplateSubstitution:

Տե՛ս Տպելու ձևանմուշի ընդլայնման ձեռնարկ։

Պարամետրեր

name - Տպելու ձևանմուշի ներքին անուն:
type - Տպելու ձևանմուշի տիպ:
printTemplateSubstitution - Տպելու ձևանմուշի տեղադրվող արժեքները պարունակող օբյեկտ։
document - Տպելու ձևանմուշի հետ կապակցված փաստաթղթի օբյեկտ։ Կարող է փոխանցվել null, եթե տպելու ձևը կապված չէ փաստաթղթի հետ։

EvalAndAddUserDefinedParametersEx

public Task EvalAndAddUserDefinedParametersEx(
    string name, SubstitutionType type,
    PrintTemplateSubstitutionEx printTemplateSubstitutionEx,
    Document.Document document)

Տե՛ս Տպելու ձևանմուշի ընդլայնման ձեռնարկ։

Պարամետրեր

name - Տպելու ձևանմուշի ներքին անուն:
type - Տպելու ձևանմուշի տիպ:
printTemplateSubstitutionEx - Տպելու ձևանմուշի տեղադրվող արժեքները տիպիզացված ձևով պարունակող օբյեկտ։
document - Տպելու ձևանմուշի հետ կապակցված փաստաթղթի օբյեկտ։ Կարող է փոխանցվել null, եթե տպելու ձևը կապված չէ փաստաթղթի հետ։

GetReadyTemplateSubstitution

public Task<ITemplateSubstitution> GetReadyTemplateSubstitution(
    Document.Document document,
    string templateName,
    SubstitutionType templateType,
    Dictionary<string, object> parameters)

Հաշվարկում է փաստաթղթին կապակցված տպելու ձևանմուշի տեղադրվող արժեքները, օգտագործողի կողմից նկարագրված պարամետրերը և վերադարձնում տպելու ձևանմուշի տեղադրվող արժեքները պարունակող օբյեկտը։

Տե՛ս օրինակը։

Պարամետրեր

document - Տպելու ձևանմուշի հետ կապակցված փաստաթուղթ։
templateName - Տպելու ձևանմուշի ներքին անունը։
templateType - Տպելու ձևանմուշի տիպ:
parameters - Տպելու ձևանմուշի լրացման պարամետրերի Dictionary, որտեղ բանալին՝ պարամետրի անունն է, իսկ արժեքը՝ պարամետրի արժեքը: Այս պարամետրի արժեքը փոխանցվելու է տպելու ձևանմուշի տեղադրվող արժեքները հաշվարկող TemplateSubstitution իրադարձության մշակիչին։

IsTemplateAvailable

public Task<bool> IsTemplateAvailable(
    string templateName, string templateType, Document document)

Ստուգում է արդյոք նշված ձևանմուշը հասանելի է նշված փաստաթղթի համար, այսինքն փաստաթղթի տիպը նշված է տպվող ձևանմուշի փաստաթղթերի ցանկում և բավարարվում է ակտիվացման բանաձևը սերվիսում։

Պարամետրեր

templateName - Տպելու ձևանմուշի ներքին անունը։
templateType - Տպելու ձևանմուշի տիպ:
document - Տպելու ձևանմուշի հետ կապակցված փաստաթղթի օբյեկտ։

Օգտագործում

Սերվիսում ակտիվացման բանաձևի սահմանման համար անհրաժեշտ է ստեղծել սերվերային մոդուլ, որում C# դաս ու ֆունկցիա, որը հաշվարկում է ակտիվացման բանաձևը։

Ակտիվացման բանաձևը հաշվարկող ֆունկցիայի վերադարձվող արժեքի տիպը պետք է լինի bool և որպես պարամետր պետք է ստանա Document դասի օբյեկտ։

Սերվերային մոդուլի և C# դասի լրացումից հետո անհրաժեշտ է սերվերային մոդուլը նկարագրող .as ընդլայնմամբ ֆայլը ներմուծել տվյալների բազա Syscon գործիքի միջոցով։

Դասի ու ֆունկցիայի սահմանումից հետո «Փաստաթղթի տպելու ձևանմուշներ» դիտելու ձևում տպելու ձևանմուշի վրայից սեղմելով «Խմբագրել» ֆունկցիայով բացվող պատուհանի «Ակտիվացման բանաձև սերվիսում» դաշտում անհրաժեշտ է այն լրացնել սերվերային մոդուլի անունը, դասի անունը և ֆունկցիայի անւնը՝ իրարից անջատելով կետերով՝ server_side_module_name.class_name.function_name:

Օրինակ՝

//SERVERSIDEMODULE { NAME = MyModule;
//public class MyClass {
public bool IsAvailable(Document doc)

Ակտիվացման բանաձև սերվիսում կլինի MyModule.MyClass.IsAvailable

LoadAndSubstitute

public Task<Stream> LoadAndSubstitute(
    IPrintTemplateSubstitution printTemplateSubstitution, 
    string name, SubstitutionType type, 
    HtmlImageOption htmlImageOption = default,
    string outputPassword = "", bool check = false)

Բեռնում է տպելու ձևանմուշը տվյալների պահոցից, լրացնում printTemplateSubstitution-ում պարունակվող նախապես հաշվարկված տվյալներով և ստացված ֆայլը վերադարձնում որպես Stream:

Պարամետրեր

printTemplateSubstitution - Տպելու ձևանմուշի տեղադրվող արժեքները պարունակող օբյեկտ։
name - Տպելու ձևանմուշի ներքին անուն:
type - Տպելու ձևանմուշի տիպ:
htmlImageOption - Html տպվող տեսքերի պատկերների տեղադրման եղանակ։
outputPassword - Վերջնական ֆայլի բացման գաղտնաբառը։
check - Տպելու ձևանմուշում առկա կոդերի ճիշտ շարահյուսության ստուգման հայտանիշ։

LoadSubstituteAndGetContent

public Task<string> LoadSubstituteAndGetContent(
    IPrintTemplateSubstitution printTemplateSubstitution, 
    string name, SubstitutionType type, 
    HtmlImageOption htmlImageOption = default,
    bool check = false)

Բեռնում է տպելու ձևանմուշը տվյալների պահոցից, լրացնում printTemplateSubstitution-ում պարունակվող նախապես հաշվարկված տվյալներով և ստացված ֆայլը վերադարձնում որպես տեքստ։

Նախատեսված է htm և txt տիպի ձևանմուշների լրացումից հետո վերջնական տեքստը ստանալու համար։

Տե՛ս օրինակը։

Պարամետրեր

printTemplateSubstitution - Տպելու ձևանմուշի տեղադրվող արժեքները պարունակող օբյեկտ։
name - Տպելու ձևանմուշի ներքին անուն:
type - Տպելու ձևանմուշի տիպ:
htmlImageOption - Html տպվող տեսքերի պատկերների տեղադրման եղանակ։
check - Տպելու ձևանմուշում առկա կոդերի ճիշտ շարահյուսության ստուգման հայտանիշ։

LoadSubstitutionAndGetStorage

public Task<StorageInfo> LoadSubstitutionAndGetStorage(
    IPrintTemplateSubstitution printTemplateSubstitution, 
    string name, SubstitutionType type, 
    HtmlImageOption htmlImageOption = default,
    string outputPassword = "", bool check = false)

Բեռնում է տպելու ձևանմուշը տվյալների պահոցից, լրացնում printTemplateSubstitution-ում պարունակվող նախապես հաշվարկված տվյալներով, պահում ֆայլում և վերադարձնում ֆայլի նույնականացուցիչը սերվերում։

Պարամետրեր

printTemplateSubstitution - Տպելու ձևանմուշի տեղադրվող արժեքները պարունակող օբյեկտ։
name - Տպելու ձևանմուշի ներքին անուն:
type - Տպելու ձևանմուշի տիպ:
htmlImageOption - Html տպվող տեսքերի պատկերների տեղադրման եղանակ։
outputPassword - Վերջնական ֆայլի բացման գաղտնաբառը։
check - Տպելու ձևանմուշում առկա կոդերի ճիշտ շարահյուսության ստուգման հայտանիշ։

LoadTemplateFile

public Task<(bool IsUnicode, byte[] File, bool Updatable)> LoadTemplateFile(
    string name, SubstitutionType type)

Բեռնում է տպելու ձևանմուշի տվյալները պահոցի TEMPLATES աղյուսակից։ Բեռնման ընթացքում կատարվում է լրացուցիչ ստուգումներ, որից հետո հնարավոր է լրացնել ֆայլը։ Ստացված տվյալները ենթակա են փոխանցման EvalAndAddUserDefinedParameters, ապա Substitute կամ SubstituteAndGetContent մեթոդներին։

Վերադարձնում է կորտեժ

IsUnicode - Տպելու ձևանմուշը հարկավոր է արտահանել յունիկոդ կոդավորմամբ։
File - Տպելու ձևանմուշի պարունակությունը որպես բայտերի զանգված։
Updatable - Տպելու ձևանմուշը լրացնելուց հետո հարկավոր է դարձնել ոչ խմբագրելի։

Պարամետրեր

name - Տպելու ձևանմուշի ներքին անուն:
type - Տպելու ձևանմուշի տիպ:

MergeFile

public Task MergeFile(SubstitutionType type, StorageInfo targetFile, 
                      StorageInfo sourceFile, bool insertPageBreak,
                      bool check = false)

Միավորում է երկու տպելու ձևանմուշից ստեղծված docx ֆայլեր՝ տեղադրելով մեկ ընդհանուր ֆայլի մեջ։ Միավորված ֆայլը գրանցում է targetFile-ի մեջ։

Պարամետրեր

type - Տպելու ձևանմուշի տիպ:
targetFile - Առաջին ֆայլի նույնականացուցիչը սերվերում, որին կավելանա երկրորդ ֆայլը։
sourceFile - Երկրորդ ֆայլի նույնականացուցիչը սերվերում։
insertPageBreak - Երկու ֆայլերի պարունակությունների միջև break-ի նշանի տեղադրման հայտանիշ։
check - Տպելու ձևանմուշում առկա կոդերի ճիշտ շարահյուսության ստուգման հայտանիշ։

MergeFile

public Task<Stream> MergeFile(SubstitutionType type, byte[] targetFile, 
                              byte[] sourceFile, bool insertPageBreak, 
                              bool check = false)

Միավորում է երկու տպելու ձևանմուշից ստեղծված docx ֆայլեր՝ տեղադրելով մեկ ընդհանուր ֆայլի մեջ։ Միավորված ֆայլը վերադարձնում է որպես Stream:

Պարամետրեր

type - Տպելու ձևանմուշի տիպ:
targetFile - Առաջին ֆայլի նույնականացուցիչը սերվերում։
sourceFile - Երկրորդ ֆայլի նույնականացուցիչը սերվերում։
insertPageBreak - Երկու ֆայլերի պարունակությունների միջև break-ի նշանի տեղադրման հայտանիշ։
check - Տպելու ձևանմուշում առկա կոդերի ճիշտ շարահյուսության ստուգման հայտանիշ։

Substitute

public Task<Stream> Substitute(IPrintTemplateSubstitution printTemplateSubstitution, 
                               byte[] file, SubstitutionType type,
                               HtmlImageOption htmlImageOption = default, 
                               bool isUnicode = false, string outputPassword = "",
                               bool protect = false, bool check = false)

Լրացնում Է տպելու ձևանմուշը printTemplateSubstitution-ում պարունակվող նախապես հաշվարկված տվյալներով և վերադարձնում որպես Stream:

Պարամետրեր

printTemplateSubstitution - Տպելու ձևանմուշի տեղադրվող արժեքները պարունակող օբյեկտ։
file - Տպելու ձևանմուշի պարունակությունը որպես բայտերի զանգված։
type - Տպելու ձևանմուշի տիպ:
htmlImageOption - Html տպվող տեսքերի պատկերների տեղադրման եղանակ։
isUnicode - Տպելու ձևանմուշը արտահանել յունիկոդ կոդավորմամբ։
outputPassword - Վերջնական ֆայլի բացման գաղտնաբառը։
protect - true արժեքի դեպքում տպելու ձևանմուշի ֆայլը բացվում է միայն կարդալու թույլտվությամբ, հակառակ դեպքում՝ կարդալու/խմբագրելու թույլտվությամբ։
check - Տպելու ձևանմուշում առկա կոդերի ճիշտ շարահյուսության ստուգման հայտանիշ։

SubstituteAndGetContent

public string SubstituteAndGetContent(IPrintTemplateSubstitution printTemplateSubstitution, 
                                      byte[] file, SubstitutionType type, 
                                      HtmlImageOption htmlImageOption = default,
                                      bool isUnicode = false, bool check = false)

Լրացնում Է տպելու ձևանմուշը printTemplateSubstitution-ում պարունակվող նախապես հաշվարկված տվյալներով և վերադարձնում որպես տեքստ։

Պարամետրեր

printTemplateSubstitution - Տպելու ձևանմուշի տեղադրվող արժեքները պարունակող օբյեկտ։
file - Տպելու ձևանմուշի պարունակությունը որպես byte տիպի զանգված։
type - Տպելու ձևանմուշի տիպ:
htmlImageOption - Html տպվող տեսքերի պատկերների տեղադրման եղանակ։
isUnicode - Տպելու ձևանմուշի տվյալների Unicode կոդավորմամբ լրացման հայտանիշ։
check - Տպելու ձևանմուշում առկա կոդերի ճիշտ շարահյուսության ստուգման հայտանիշ։