دفتر العمل

تحدد Options خيارات قراءة وكتابة جداول البيانات.

type Options struct {
    MaxCalcIterations uint
    Password          string
    RawCellValue      bool
    UnzipSizeLimit    int64
    UnzipXMLSizeLimit int64
    ShortDatePattern  string
    LongDatePattern   string
    LongTimePattern   string
    CultureInfo       CultureName
}

يحدد MaxCalcIterations الحد الأقصى من التكرارات للحساب التكراري ، والقيمة الافتراضية هي 0.

تحدد Password كلمة مرور جدول البيانات بنص عادي.

يحدد RawCellValue ما إذا كان يتم تطبيق تنسيق الأرقام لقيمة الخلية أو الحصول على القيمة الأولية.

يحدّد UnzipSizeLimit حد حجم فك الضغط بالبايت عند فتح جدول البيانات ، ويجب أن تكون هذه القيمة أكبر من أو تساوي UnzipXMLSizeLimit ، الحد الافتراضي للحجم هو 16 غيغابايت.

يحدد UnzipXMLSizeLimit حد الذاكرة لفك ضغط ورقة العمل بالبايت ، وسيتم استخراج XML لورقة العمل إلى دليل النظام المؤقت عندما يكون حجم الملف أكبر من هذه القيمة ، يجب أن تكون هذه القيمة أقل من أو تساوي UnzipSizeLimit ، القيمة الافتراضية هي 16 ميغا بايت.

يحدد ShortDatePattern رمز تنسيق رقم التاريخ القصير. في تطبيقات جداول البيانات ، تعرض تنسيقات التاريخ الأرقام التسلسلية للتاريخ والوقت كقيم للتاريخ. تستجيب تنسيقات التاريخ التي تبدأ بعلامة النجمة (*) للتغييرات في إعدادات التاريخ والوقت الإقليمية المحددة لنظام التشغيل. لا تتأثر التنسيقات التي لا تحتوي على علامة النجمة بإعدادات نظام التشغيل. يحدد ShortDatePattern المستخدم لتنسيقات التاريخ التي تبدأ بعلامة النجمة.

يحدد LongDatePattern رمز تنسيق رقم التاريخ الطويل.

يحدد LongTimePattern رمز تنسيق الرقم لفترة طويلة.

يحدد CultureInfo رمز البلد لتطبيق كود تنسيق رقم اللغة المدمج الذي يؤثر على إعدادات اللغة المحلية للنظام.

قم بإنشاء جدول بيانات

func NewFile(opts ...Options) *File

يوفر NewFile وظيفة لإنشاء ملف جديد بواسطة القالب الافتراضي. سيحتوي المصنف الذي تم إنشاؤه حديثًا بشكل افتراضي على ورقة عمل باسم Sheet1. فمثلا:

افتح

func OpenFile(filename string, opts ...Options) (*File, error)

يأخذ OpenFile اسم ملف جدول البيانات ويعيد بنية ملف جدول بيانات معبأة له. على سبيل المثال ، افتح جدول بيانات محميًا بكلمة مرور:

f, err := excelize.OpenFile("المصنف1.xlsx", excelize.Options{Password: "password"})
if err != nil {
    return
}

أغلق الملف عن طريق Close() بعد فتح جدول البيانات.

فتح دفق البيانات

func OpenReader(r io.Reader, opts ...Options) (*File, error)

يقوم OpenReader بقراءة دفق البيانات من io.Reader وإرجاع ملف جدول بيانات ممتلئ.

على سبيل المثال ، أنشئ خادم HTTP للتعامل مع قالب التحميل ، ثم استجابة ملف التنزيل مع إضافة ورقة عمل جديدة:

package main

import (
    "fmt"
    "net/http"

    "github.com/xuri/excelize/v2"
)

func process(w http.ResponseWriter, req *http.Request) {
    file, _, err := req.FormFile("file")
    if err != nil {
        fmt.Fprint(w, err.Error())
        return
    }
    defer file.Close()
    f, err := excelize.OpenReader(file)
    if err != nil {
        fmt.Fprint(w, err.Error())
        return
    }
    f.Path = "Book1.xlsx"
    f.NewSheet("NewSheet")
    w.Header().Set("Content-Disposition", fmt.Sprintf("attachment; filename=%s", f.Path))
    w.Header().Set("Content-Type", req.Header.Get("Content-Type"))
    if err := f.Write(w); err != nil {
        fmt.Fprint(w, err.Error())
    }
}

func main() {
    http.HandleFunc("/process", process)
    http.ListenAndServe(":8090", nil)
}

اختبار مع cURL:

curl --location --request GET 'http://127.0.0.1:8090/process' \
--form 'file=@/tmp/template.xltx' -O -J

حفظ

func (f *File) Save(opts ...Options) error

يوفر Save وظيفة لتجاوز جدول البيانات بمسار الأصل.

حفظ باسم

func (f *File) SaveAs(name string, opts ...Options) error

يوفر SaveAs وظيفة لإنشاء أو تحديث جدول بيانات في المسار المتوفر.

إغلاق المصنف

func (f *File) Close() error

يقوم Close بإغلاق وتنظيف الملف المؤقت المفتوح لجدول البيانات.

قم بإنشاء ورقة عمل

func (f *File) NewSheet(sheet string) (int, error)

يوفر NewSheet وظيفة لإنشاء ورقة جديدة من خلال إعطاء اسم ورقة العمل وإرجاع فهرس الأوراق في المصنف (جدول البيانات) بعد إلحاقه. لاحظ أنه عند إنشاء ملف جدول بيانات جديد ، سيتم إنشاء ورقة العمل الافتراضية المسماة Sheet1.

احذف ورقة العمل

func (f *File) DeleteSheet(sheet string) error

يوفر DeleteSheet وظيفة لحذف ورقة العمل في مصنف حسب اسم ورقة العمل المحدد ، وأسماء الأوراق ليست حساسة لحالة الأحرف. استخدم هذه الطريقة بحذر ، مما سيؤثر على التغييرات في المراجع مثل الصيغ والمخططات وما إلى ذلك. إذا كان هناك أي قيمة مرجعية لورقة العمل المحذوفة ، فسوف يتسبب ذلك في حدوث خطأ في الملف عند فتحه. ستكون هذه الوظيفة غير صالحة عند ترك ورقة عمل واحدة فقط.

نسخ ورقة العمل

func (f *File) CopySheet(from, to int) error

يوفر CopySheet وظيفة لتكرار ورقة العمل من خلال إعطاء فهرس ورقة العمل المصدر والهدف. لاحظ أنه لا يدعم حاليًا المصنفات المكررة التي تحتوي على جداول أو مخططات أو صور. فمثلا:

// Sheet1 موجود بالفعل...
index, err := f.NewSheet("Sheet2")
if err != nil {
    fmt.Println(err)
    return
}
err := f.CopySheet(1, index)

أوراق عمل المجموعة

func (f *File) GroupSheets(sheets []string) error

توفر GroupSheets وظيفة لتجميع أوراق العمل حسب اسم أوراق العمل المحدد. يجب أن تحتوي أوراق العمل الجماعية على ورقة عمل نشطة.

فك تجميع أوراق العمل

func (f *File) UngroupSheets() error

توفر UngroupSheets وظيفة لفك تجميع أوراق العمل.

تعيين خلفية ورقة العمل

func (f *File) SetSheetBackground(sheet, picture string) error

يوفر SetSheetBackground وظيفة لتعيين صورة الخلفية عن طريق اسم ورقة العمل ومسار الملف. أنواع الصور المدعومة: BMP و EMF و EMZ و GIF و JPEG و JPG و PNG و SVG و TIF و TIFF و WMF و WMZ.

func (f *File) SetSheetBackgroundFromBytes(sheet, extension string, picture []byte) error

يوفر SetSheetBackgroundFromBytes وظيفة لتعيين صورة الخلفية عن طريق اسم ورقة العمل المعطى واسم الامتداد وبيانات الصورة. أنواع الصور المدعومة: BMP و EMF و EMZ و GIF و JPEG و JPG و PNG و SVG و TIF و TIFF و WMF و WMZ.

تعيين ورقة العمل الافتراضية

func (f *File) SetActiveSheet(index int)

يوفر SetActiveSheet وظيفة لتعيين الورقة النشطة الافتراضية للمصنف بواسطة فهرس معين. لاحظ أن الفهرس النشط يختلف عن المعرف الذي تم إرجاعه بواسطة الوظيفة GetSheetMap. يجب أن يكون أكبر أو يساوي 0 وأقل من إجمالي أرقام ورقة العمل.

احصل على فهرس الورقة النشط

func (f *File) GetActiveSheetIndex() int

يوفر GetActiveSheetIndex وظيفة للحصول على ورقة عمل نشطة من المصنف. إذا لم يتم العثور على الورقة النشطة ، فستعرض عددًا صحيحًا 0.

تعيين ورقة العمل مرئية

func (f *File) SetSheetVisible(sheet string, visible bool, veryHidden ...bool) error

يوفر SetSheetVisible وظيفة لتعيين ورقة العمل مرئية من خلال اسم ورقة العمل المحدد. يجب أن يحتوي المصنف على ورقة عمل مرئية واحدة على الأقل. إذا تم تنشيط ورقة العمل المحددة ، فسيتم إبطال هذا الإعداد. لا تعمل المعلمة الاختيارية الثالثة veryHidden إلا عندما تكون visible هي false.

على سبيل المثال ، إخفاء Sheet1:

err := f.SetSheetVisible("Sheet1", false)

احصل على ورقة العمل مرئية

func (f *File) GetSheetVisible(sheet string) (bool, error)

يوفر GetSheetVisible وظيفة لإظهار ورقة العمل من خلال اسم ورقة العمل المحدد. على سبيل المثال ، احصل على الحالة المرئية لـ Sheet1:

visible, err := f.GetSheetVisible("Sheet1")

تعيين خصائص الورقة

func (f *File) SetSheetProps(sheet string, opts *SheetPropsOptions) error

يوفر SetSheetProps وظيفة لتعيين خصائص ورقة العمل. الخصائص التي يمكن تعيينها هي:

على سبيل المثال ، اجعل صفوف ورقة العمل الافتراضية مخفية:

f, enable := excelize.NewFile(), true
if err := f.SetSheetView("Sheet1", -1, &excelize.ViewOptions{
    RightToLeft: &enable,
}); err != nil {
    fmt.Println(err)
}
if err := f.SetSheetProps("Sheet1", &excelize.SheetPropsOptions{
    ZeroHeight: &enable,
}); err != nil {
    fmt.Println(err)
}
if err := f.SetRowVisible("Sheet1", 10, true); err != nil {
    fmt.Println(err)
}
f.SaveAs("المصنف1.xlsx")

الحصول على خصائص ورقة

func (f *File) GetSheetProps(sheet string) (SheetPropsOptions, error)

يوفر GetSheetProps دالة للحصول على خصائص ورقة العمل. الخصائص التي يمكن تعيينها هي:

تعيين خصائص عرض ورقة العمل

func (f *File) SetSheetView(sheet string, viewIndex int, opts *ViewOptions) error

تعيين SetSheetView خصائص عرض الورقة. قد يكون viewIndex سالبًا وإذا كان الأمر كذلك يتم حسابه تنازليًا (-1 هو العرض الأخير).

احصل على خصائص عرض ورقة العمل

func (f *File) GetSheetView(sheet string, viewIndex int) (ViewOptions, error)

يحصل GetSheetView على قيمة خصائص عرض الورقة. قد يكون viewIndex سالبًا وإذا كان الأمر كذلك يتم حسابه تنازليًا (-1 هو العرض الأخير).

تعيين تخطيط صفحة ورقة العمل

func (f *File) SetPageLayout(sheet string, opts *PageLayoutOptions) error

يوفر SetPageLayout وظيفة لتعيين تخطيط صفحة ورقة العمل. الخيارات المتاحة:

حدد Size حجم ورق ورقة العمل ، وحجم الورق الافتراضي لورقة العمل هو "ورق إلكتروني (8.5 بوصة × 11 بوصة)". يوضح ما يلي حجم الورق مرتبة حسب رقم فهرس Excelize:

حدد Orientation المحدد في اتجاه ورقة العمل ، والاتجاه الافتراضي هو portrait. القيم المحتملة لهذا الحقل هي portrait و landscape.

حدد FirstPageNumber رقم أول صفحة مطبوعة. إذا لم يتم تحديد قيمة ، فسيتم افتراض "تلقائي".

حدد AdjustTo مقياس الطباعة. هذه السمة مقيدة بقيم تتراوح من 10 (10٪) إلى 400 (400٪). يتم تجاوز هذا الإعداد عند استخدام FitToWidth و / أو FitToHeight.

حدد FitToHeight عدد الصفحات الرأسية التي سيتم احتواؤها.

حدد FitToWidth عدد الصفحات الأفقية التي يجب احتواؤها.

حدد BlackAndWhite الطباعة بالأبيض والأسود.

• على سبيل المثال ، عيّن تخطيط الصفحة لـ Sheet1 بطباعة بالأبيض والأسود ، ورقم الصفحة الأول المطبوع من 2 ، وورق A4 صغير الحجم أفقيًا (210 مم × 297 مم) ، صفحتان رأسيتان للملاءمة وصفحتان أفقيتان لملاءمتهما:

f := excelize.NewFile()
var (
    size                 = 10
    orientation          = "landscape"
    firstPageNumber uint = 2
    adjustTo        uint = 100
    fitToHeight          = 2
    fitToWidth           = 2
    blackAndWhite        = true
)
if err := f.SetPageLayout("Sheet1", &excelize.PageLayoutOptions{
    Size:            &size,
    Orientation:     &orientation,
    FirstPageNumber: &firstPageNumber,
    AdjustTo:        &adjustTo,
    FitToHeight:     &fitToHeight,
    FitToWidth:      &fitToWidth,
    BlackAndWhite:   &blackAndWhite,
}); err != nil {
    fmt.Println(err)
}

احصل على تخطيط صفحة ورقة العمل

func (f *File) GetPageLayout(sheet string) (PageLayoutOptions, error)

يوفر GetPageLayout وظيفة للحصول على تخطيط صفحة ورقة العمل.

تعيين هوامش صفحة ورقة العمل

func (f *File) SetPageMargins(sheet string, opts *PageLayoutMarginsOptions) error

يوفر SetPageMargins وظيفة لتعيين هوامش صفحة ورقة العمل. الخيارات المتاحة:

احصل على هوامش صفحة ورقة العمل

func (f *File) GetPageMargins(sheet string) (PageLayoutMarginsOptions, error)

يوفر GetPageMargins وظيفة للحصول على هوامش صفحة ورقة العمل.

تعيين خصائص المصنف

func (f *File) SetWorkbookProps(opts *WorkbookPropsOptions) error

يوفر SetWorkbookProps دالة لتعيين خصائص المصنف. الخيارات المتاحة:

احصل على خصائص المصنف

func (f *File) GetWorkbookProps() (WorkbookPropsOptions, error)

يوفر GetWorkbookProps دالة للحصول على خصائص المصنف.

تعيين الرأس والتذييل

func (f *File) SetHeaderFooter(sheet string, opts *HeaderFooterOptions) error

يوفر SetHeaderFooter وظيفة لتعيين الرؤوس والتذييلات من خلال اسم ورقة العمل المحددة وأحرف التحكم.

يتم تحديد الرؤوس والتذييلات باستخدام حقول الإعدادات التالية:

يمكن استخدام رموز التنسيق التالية في 6 حقول من نوع السلسلة: OddHeader, OddFooter, EvenHeader, EvenFooter, FirstFooter, FirstHeader

فمثلا:

err := f.SetHeaderFooter("Sheet1", &excelize.HeaderFooterOptions{
    DifferentFirst:   true,
    DifferentOddEven: true,
    OddHeader:        "&R&P",
    OddFooter:        "&C&F",
    EvenHeader:       "&L&P",
    EvenFooter:       "&L&D&R&T",
    FirstHeader:      `&CCenter &"-,Bold"Bold&"-,Regular"HeaderU+000A&D`,
})

يوضح هذا المثال:

• تحتوي الصفحة الأولى على رأس وتذييل خاصين بها
• الصفحات الفردية والزوجية لها رؤوس وتذييلات مختلفة
• رقم الصفحة الحالي في القسم الأيمن من رؤوس الصفحات الفردية
• اسم ملف المصنف الحالي في القسم الأوسط من تذييلات الصفحات الفردية
• رقم الصفحة الحالي في القسم الأيسر من رؤوس الصفحات الزوجية
• التاريخ الحالي في القسم الأيسر والوقت الحالي في القسم الأيمن من تذييلات الصفحات الزوجية
• النص "Center Bold Header" في السطر الأول من القسم الأوسط من الصفحة الأولى ، والتاريخ في السطر الثاني من القسم الأوسط من نفس الصفحة
• لا يوجد تذييل في الصفحة الأولى

تعيين الاسم المحدد

func (f *File) SetDefinedName(definedName *DefinedName) error

يوفر SetDefinedName دالة لتعيين الأسماء المحددة للمصنف أو ورقة العمل. إذا لم يتم تحديد النطاق ، فإن النطاق الافتراضي هو المصنف. فمثلا:

err := f.SetDefinedName(&excelize.DefinedName{
    Name:     "Amount",
    RefersTo: "Sheet1!$A$2:$D$5",
    Comment:  "defined name comment",
    Scope:    "Sheet2",
})

إعدادات منطقة الطباعة وعناوين الطباعة لورقة العمل:

if err := f.SetDefinedName(&excelize.DefinedName{
    Name:     "_xlnm.Print_Area",
    RefersTo: "Sheet1!$A$1:$Z$100",
    Scope:    "Sheet1",
}); err != nil {
    fmt.Println(err)
}
if err := f.SetDefinedName(&excelize.DefinedName{
    Name:     "_xlnm.Print_Titles",
    RefersTo: "Sheet1!$A:$A,Sheet1!$1:$1",
    Scope:    "Sheet1",
}); err != nil {
    fmt.Println(err)
}

احصل على اسم محدد

func (f *File) GetDefinedName() []DefinedName

يوفر GetDefinedName دالة للحصول على الأسماء المحددة للمصنف أو ورقة العمل.

حذف الاسم المحدد

func (f *File) DeleteDefinedName(definedName *DefinedName) error

يوفر DeleteDefinedName وظيفة لحذف الأسماء المعرفة للمصنف أو ورقة العمل. إذا لم يتم تحديد النطاق ، فإن النطاق الافتراضي هو المصنف. فمثلا:

err := f.DeleteDefinedName(&excelize.DefinedName{
    Name:     "Amount",
    Scope:    "Sheet2",
})

تعيين خصائص التطبيق

func (f *File) SetAppProps(appProperties *AppProperties) error

يوفر SetAppProps وظيفة لتعيين خصائص تطبيق المستند. الخصائص التي يمكن تعيينها هي:

فمثلا:

err := f.SetAppProps(&excelize.AppProperties{
    Application:       "Microsoft Excel",
    ScaleCrop:         true,
    DocSecurity:       3,
    Company:           "Company Name",
    LinksUpToDate:     true,
    HyperlinksChanged: true,
    AppVersion:        "16.0000",
})

احصل على خصائص التطبيق

func (f *File) GetAppProps() (*AppProperties, error)

يوفر GetAppProps وظيفة للحصول على خصائص تطبيق المستند.

تعيين خصائص الوثيقة

func (f *File) SetDocProps(docProperties *DocProperties) error

يوفر SetDocProps وظيفة لتعيين خصائص الوثيقة الأساسية. الخصائص التي يمكن تعيينها هي:

فمثلا:

err := f.SetDocProps(&excelize.DocProperties{
    Category:       "category",
    ContentStatus:  "Draft",
    Created:        "2019-06-04T22:00:10Z",
    Creator:        "Go Excelize",
    Description:    "This file created by Go Excelize",
    Identifier:     "xlsx",
    Keywords:       "Spreadsheet",
    LastModifiedBy: "Go Author",
    Modified:       "2019-06-04T22:00:10Z",
    Revision:       "0",
    Subject:        "Test Subject",
    Title:          "Test Title",
    Language:       "en-US",
    Version:        "1.0.0",
})

احصل على خصائص المستند

func (f *File) GetDocProps() (*DocProperties, error)

يوفر GetDocProps وظيفة للحصول على خصائص المستند الأساسية.

حماية المصنف

func (f *File) ProtectWorkbook(opts *WorkbookProtectionOptions) error

يوفر ProtectWorkbook وظيفة لمنع المستخدمين الآخرين من تغيير أو نقل أو حذف البيانات في مصنف عن طريق الخطأ أو عن عمد. الحقل الاختياري AlgorithmName خوارزمية التجزئة المحددة ، ودعم XOR و MD4 و MD5 و SHA-1 و SHA2-56 و SHA-384 و SHA-512 حاليًا ، إذا لم يتم تحديد خوارزمية تجزئة ، فسيتم استخدام خوارزمية XOR كإعداد افتراضي. على سبيل المثال ، حماية المصنف بإعدادات الحماية:

err := f.ProtectWorkbook(&excelize.WorkbookProtectionOptions{
    Password:      "password",
    LockStructure: true,
})

WorkbookProtectionOptions تعيين إعدادات حماية المصنف مباشرة.

type WorkbookProtectionOptions struct {
    AlgorithmName string
    Password      string
    LockStructure bool
    LockWindows   bool
}

إلغاء حماية المصنف

func (f *File) UnprotectWorkbook(password ...string) error

يوفر UnprotectWorkbook وظيفة لإزالة الحماية للمصنف ، وحدد معلمة كلمة المرور الاختيارية لإزالة حماية المصنف باستخدام التحقق من كلمة المرور.