Edukiak
Indizea 🔎︎

# SFDocuments.Calc zerbitzua

SFDocuments liburutegiak LibreOffice Calc dokumentuen kudeaketa eta maneiua errazteko metodoak eta propietateak eskaintzen ditu.

Zenbait metodo dokumentu mota guztietarako generikoak dira eta Document zerbitzutik heredatutakoak dira, eta beste batzuk SF_Calc modulukoak espezifikoak dira.

SF_Calc modulua honetarako da:

- Calc dokumentu bateko orriak kudeatzeko (kopiatu, txertatu, lekuz aldatu, etab.)

- Basic datu-egituren eta Calc barrutien arteko datuak trukatzeko

- Datu kantitate masiboak kopiatzeko eta inportatzeko

## Zerbitzuari deitzea

Calc zerbitzua eta UI ScriptForge liburutegiaren zerbitzua estu lotuta daude. Behean ageri dira Calc zerbitzua deitzeko moduak adierazten dituzten zenbait adibide.

##### Basic lengoaian

Beheko kode-zatiak uneko Calc dokumentu aktiboari dagokion Calc zerbitzu-instantzia bat sortzen du.

        Set oDoc = CreateScriptService("Calc")

Calc zerbitzuaren beste instantzia bat sortzeko beste modu bat UI zerbitzua erabiltzea da. Hurrengo adibidean, Calc dokumentu berria sortzen da eta oDoc elementua Calc zerbitzuaren instantzia bat da:

        Dim ui As Object, oDoc As Object
        Set ui = CreateScriptService("UI")
        Set oDoc = ui.CreateDocument("Calc")

Edo UI zerbitzuaren OpenDocument metodoa erabilita:

        Set oDoc = ui.OpenDocument("C:\Documents\MyFile.ods")

Posible da, baita ere, Calc zerbitzuaren instantzia bat sortzea CreateScriptService metodoa erabilita:

        Dim oDoc As Object
        Set oDoc = CreateScriptService("SFDocuments.Calc", "MyFile.ods")

Goiko adibidean, "MyFile.ods" dokumentu-leiho ireki baten izena da. Argumentu hori ematen ez bada, leiho aktiboa erabiliko da.

Gomendagarria da baliaboideak askatzea erabileraren ondoren:

        Set oDoc = oDoc.Dispose()

Hala ere, dokumentua CloseDocument metodoa erabilita itxi bada, ez da beharrezkoa baliabideak askatzea goian deskribatutako komandoaren bidez.

##### Python lengoaian

        myDoc = CreateScriptService("Calc")

        svcUI = CreateScriptService("UI")
        myDoc = svcUI.CreateDocument("Calc")

        myDoc = svcUI.OpenDocument(r"C:\Documents\MyFile.ods")

        myDoc = CreateScriptService("SFDocuments.Calc", "MyFile.ods")
        myDoc.Dispose()

"SFDocuments." aurreizkia erabiltzea aukerakoa da zerbitzuari deitzen zaionean.

## Definizioak

Metodo askok "Orria" edo "Barrutia" behar dute argumentu gisa. Gelaxka bakunak Range elementuaren kasu berezitzat hartzen dira.

Biak ala biak kate gisa edo erreferentzia (=objektu) gisa adierazi daitezke, egoeraren arabera:

- Calc instantzia espezifiko batean, orriak eta barrutiak kate gisa ematen dira, adibidez "Orria1" eta "D2:F6".

- Horrez gain, .Sheet eta .Range propietateek Calc zerbitzuaren beste instantzia batetik deitutako metodo baten argumentu gisa erabili daitekeen erreferentzia bat itzultzen dute.

### Adibidea:

Beheko adibideak (soilik irakurtzeko moduan eta ezkutuan irekitako) A dokumentuko datuak B dokumentura kopiatzen ditu.

##### Basic lengoaian

        Dim oDocA As Object, oDocB As Object
        Set oDocA = ui.OpenDocument("C:\Documents\FileA.ods", Hidden := True, ReadOnly := True)
        Set oDocB = ui.OpenDocument("C:\Documents\FileB.ods")
        oDocB.CopyToRange(oDocA.Range("SheetX.D4:F8"), "D2:F6") 'CopyToRange(source, target)

##### Python lengoaian

        docA = svcUI.OpenDocument(r"C:\Documents\FileA.ods", hidden = True, readonly = True)
        docB = svcUI.OpenDocument(r"C:\Documents\FileB.ods")
        docB.CopyToRange(docA.Range("SheetX.D4:F8"), "D2:F6")

### SheetName

Sartu orri-izena .Sheet propietateak ekoiztutako string edo object gisa.

"~" (tildea) lasterbideak uneko orria ordezkatzen du.

### RangeName

Uneko instantziako orri batean kokatutako elkarren ondoko gelaxken multzo bat adierazten duen kate bat edo .Range propietateak ekoiztutako object bat.

"~" (tileta) lasterbideak ordezkatzen du uneko hautapena edo hautatutako lehen barrutia, barruti anitz hautatuta badaude.

"*" lasterbideak erabilitako gelaxka guztiak ordezkatzen ditu.

Orri-izena aukerakoa da barruti batean (lehenespena = orri aktiboa). Komatxo bakun inguratzaileak eta $ ikurrak onartzen dira, baina ez ikusiarena egingo zaie.

CurrentSelection propietatean salbu, Calc zerbitzuak gelaxken barruti bakunak soilik hartzen ditu kontuan.

Baliozko barrutien adibideak
1) '$OrriaX'.D2 2) $D$2 | Gelaxka bakarra
1) '$OrriaX'.D2:F6 2) D2:D10 | Barruti bakarra gelaxka anitzekin
'$OrriaX'.* | Emandako orrian erabilitako gelaxka guztiak
1) '$OrriaX'.A:A (A zutabea) 2) 3:5 (3 eta 5 arteko errenkadak) | Elkarren ondoko zutabe edo errenkaden gelaxka guztiak, erabilitako azken gelaxkaraino
nireBarrutia | "nireBarrutia" deitutako barruti bat kalkulu-orriaren mailan
1) ~.barrutiBat 2) OrriaX.barrutiBat | Barruti-izen bat orri-mailan
nireDok.Range("OrriaX.D2:F6") | 'OrriaX' orriaren barruko barruti bat 'nireDok' Calc instantziarekin lotutako fitxategian
~.~ edo ~ | Orri aktiboaren uneko hautapena

## Propietateak

Edozein dokumentutarako orokorrak diren propietateak inplizituki Calc dokumentuetan ere aplikatu daitezke. Informazio gehiagorako, ikus Document zerbitzuaren laguntza-orria.

Calc dokumentuetan espezifikoki erabilgarri dauden propietateak honakoak dira:

Izena | Irakurtzeko soilik | Argumentua | Mota | Deskribapena
CurrentSelection | Ez | Bat ere ez | Katea edo kateen matrizea | Hautatutako barruti bakuna kate gisa, edo hautatutako barrutien zerrenda matrize gisa
Height | Bai | BarrutiIzena As String | Long | Errenkada kopurua (>=1) emandako barrutian
LastCell | Bai | OrriIzena As String | String | Erabilitako azken gelaxka emandako orrian, 'A1' formatuan
LastColumn | Bai | OrriIzena As String | Long | Erabilitako azken zutabea emandako orrian
LastRow | Bai | OrriIzena As String | Long | Erabilitako azken errenkada emandako orrian
Range | Bai | BarrutiIzena As String | Object | CopyToRange eta antzeko metodoetan argumentutzat erabili daitekeen barruti-erreferentzia bat
Sheet | Bai | OrriIzena As String | Object | CopySheet eta antzeko metodoetan argumentutzat erabili daitekeen orri-erreferentzia bat
Sheets | Bai | Bat ere ez | Kate-matrizea | Dauden orri guztien izenen zerrenda
Width | Bai | BarrutiIzena As String | Long | Emandako barrutiak duen zutabe kopurua (>=1)
XCellRange | Bai | BarrutiIzena As String | Object | com.sun.star.Table.XCellRange UNO objektu bat
XSpreadsheet | Bai | OrriIzena As String | Object | com.sun.star.sheet.XSpreadsheet UNO objektu bat

Begiratu LibreOffice APIaren dokumentazioaren webgunea XCellRange eta XSpreadsheet UNO objektuak hobeto ezagutzeko.

## Metodoak

Calc zerbitzuaren metodo-zerrenda
Activate ClearAll ClearFormats ClearValues CopySheet CopySheetFromFile CopyToCell CopyToRange DAvg DCount | DMax DMin DSum Forms GetColumnName GetFormula GetValue ImportFromCSVFile ImportFromDatabase InsertSheet | MoveRange MoveSheet Offset RemoveSheet RenameSheet SetArray SetValue SetCellStyle SetFormula SortRange

## Activate

OrriIzena argumentua ematen bada, emandako orria aktibatuko da eta unean hautatutako orri bihurtuko da. Argumentua ez badago, dokumentu-leihoa aktibatuko da.

### Sintaxia:

svc.Activate(sheetname: str = ""): bool

### Parametroak:

OrriIzena: Dokumentuan aktibatuko den orriaren izena. Balio lehenetsia kate hutsa da, horrek esan nahi du dokumentu-leihoa orri aktiboa aldatu gabe aktibatuko dela.

### Adibidea:

Beheko adibideak "Sheet4" izeneko orria aktibatzen du uneko dokumentu aktiboan.

##### Basic lengoaian

        Dim ui as Variant, oDoc as Object
        Set ui = CreateScriptService("UI")
        Set oDoc = ui.GetDocument(ui.ActiveWindow)
        oDoc.Activate("Sheet4")

##### Python lengoaian

        svcUI = CreateScriptService("UI")
        myDoc = svcUI.GetDocument(svcUI.ActiveWindow)
        myDoc.Activate("Sheet4")

Orri bat aktibatzea zentzuzkoa izateko, Calc dokumentu batean egin behar da. Calc dokumentu bat eskura duzula ziurtatzeko, erabili dokumentu-objektuaren isCalc propietatea. Horrek True (egia) itzuliko du Calc dokumentu bat bada eta False (faltsua) ez bada.

## ClearAll

Emandako barrutiaren eduki eta formatu guztiak garbitzen ditu.

### Sintaxia:

svc.ClearAll(range: str)

### Parametroak:

range: Garbituko den barrutia, kate gisa.

### Adibidea:

##### Basic lengoaian

          oDoc.ClearAll("SheetX.A1:F10")

##### Python lengoaian

        myDoc.ClearAll("SheetX.A1:F10")

## ClearFormats

Emandako barrutiaren formatuak eta estiloak garbitzen ditu.

### Sintaxia:

svc.ClearFormats(range: str)

### Parametroak:

range: Formatuak eta estiloak garbituko zaizkion barrutia, kate gisa.

### Adibidea:

##### Basic lengoaian

          oDoc.ClearFormats("SheetX.*")

##### Python lengoaian

        myDoc.ClearFormats("SheetX.*")

## ClearValues

Emandako barrutiaren balioak eta formulak garbitzen ditu.

### Sintaxia:

svc.ClearValues(range: str)

### Parametroak:

range: Balioak eta formulak garbituko zaizkion barrutia, kate gisa.

### Adibidea:

##### Basic lengoaian

          oDoc.ClearValues("SheetX.A1:F10")

##### Python lengoaian

        myDoc.ClearValues("SheetX.A1:F10")

## CopySheet

Zehaztutako orria lehendik dagoen orri baten aurrean edo orri-zerrendaren amaieran kopiatzen du. Kopiatuko den orriak barruan edozein Calc dokumentu ireki eduki behar du. True (egia) itzultzen du ongi egiten bada.

### Sintaxia:

svc.CopySheet(sheetname: any, newname: str, [beforesheet: any]): bool

### Parametroak:

sheetname: Kate gisa kopiatuko den edo objektu gisa haren erreferentzia egingo den orriaren izena.

newname: Txertatuko den orriaren izena. Izenak dokumentuan erabili gabea izan behar du.

beforesheet: Orri baten izena (katea) edo indizea (zenbakizkoa, 1 zenbakitik hasita). Kopiatutako orria orri honen aurretik txertatuko da. Argumentu hau aukerakoa da eta portaera lehenetsia kopiatutako orria azken posizioan gehitzea da.

### Adibidea:

##### Basic lengoaian

Hurrengo adibidez "SheetX" orriaren kopia bat egiten du eta uneko dokumentuaren azken orri gisa kokatzen du. Kopiatutako orriaren izena "SheetY" da.

        Dim oDoc as Object
        'Leiho aktiboaren dokumentu-objektua eskuratzen du
        Set oDoc = CreateScriptService("Calc")
        oDoc.CopySheet("SheetX", "SheetY")

Beheko adibideak "SheetX" kopiatzen du "FileA.ods" fitxategitik eta "FileB.ods" fitxategiaren azken posizioan kopiatzen du "SheetY" izenarekin:

          Dim oDocA As Object : Set oDocA = ui.OpenDocument("C:\Documents\FileA.ods", Hidden := True, ReadOnly := True)
          Dim oDocB As Object : Set oDocB = ui.OpenDocument("C:\Documents\FileB.ods")
          oDocB.CopySheet(oDocA.Sheet("SheetX"), "SheetY")

##### Python lengoaian

        myDoc.CopySheet("SheetX", "SheetY")

        docA = svcUI.OpenDocument(r"C:\Documents\FileA.ods", hidden = True, readonly = True)
        docB = svcUI.OpenDocument(r"C:\Documents\FileB.ods")
        docB.CopySheet(docA.Sheet("SheetX"), "SheetY")

Dokumentu irekien arteko orriak kopiatzeko, erabili CopySheet. Orriak Itxita dauden dokumentuen arten kopiatzeko, erabili CopySheetFromFile.

## CopySheetFromFile

Itxitako Calc dokumentu bateko orri jakin bat kopiatzen du eta Document objektu batek erreferentzia egiten dion fitxategiak duen orri baten aurretik edo orri-zerrendaren amaieran itsasten du.

Fitxategia existitzen ez bada, errore bat gertatuko da. Fitxategia ez bada baliozko Calc fitxategia, orri zuria txertatuko da. Iturburuko orria existitzen ez bada sarrerako fitxategian, errore-mezu bat txertatuko da itsatsi berri den orriaren goiko aldean.

### Sintaxia:

svc.CopySheetFromFile(filename: str, sheetname: str, newname: str, [beforesheet: any]): bool

### Parametroak:

filename: Irekiko den fitxategia identifikatzen du. SF_FileSystem.FileNaming notazioa jarraitu behar du. Fitxategiak ez du pasahitzarekin babestuta egon behar.

OrriIzena: Kate gisa kopiatuko den orriaren izena.

newname: Dokumentuan txertatuko den kopiatutako orriaren izena. Izenak ez du dokumentuan erabilia izan behar.

beforesheet: Kopiatutako orria zein orriren aurretik txertatuko den. Bigarren orri horren izena (katea) edo indizea (zenbakia, 1 zenbakitik hasita) izan daiteke. Argumentu hau aukerakoa da eta portaera lehenetsia da kopiatutako orria azken posizioan kopiatzea.

### Adibidea:

Hurrengo adibideak "myFile.ods" fitxategiko "SheetX" orria kopiatzen du eta "oDoc" aldagaiak "SheetY" gisa erreferentziatuta duen dokumentuan itsasten du, lehen posizioan.

##### Basic lengoaian

        oDoc.CopySheetFromFile("C:\Documents\myFile.ods", "SheetX", "SheetY", 1)

##### Python lengoaian

        myDoc.CopySheetFromFile(r"C:\Documents\myFile.ods", "SheetX", "SheetY", 1)

## CopyToCell

Zehaztutako iturburuko barruti bat (balioak, formulak eta formatuak) helburuko barruti edo gelaxka batean kopiatzen du. Metodoak kopiatu/itsatsi portaera errepikatzen du barrutik batetik gelaxka bakarrera.

Aldatutako gelaxka-barrutia ordezkatzen duen kate bat itzultzen du. Aldatutako arearen tamaina iturburuko arearen tamainak zehazten du.

Iturburu-barrutia beste dokumentu ireki batekoa izan daiteke.

### Sintaxia:

svc.CopyToCell(sourcerange: any, destinationcell: str): str

### Parametroak:

sourcerange: Iturburu-barrutia kate gisa, dokumentu berekoa denean, edo erreferentzia gisa, beste Calc dokumentu batekoa denean.

destinationcell: Kopiatutako gelaxka-barrutia itsatsiko den helburuko gelaxka, kate gisa. Barruti bat ematen bada, goiko ezkerreko gelaxka soilik hartuko da kontuan.

### Adibidea:

##### Basic lengoaian

Hurrengo adibidean, iturburua eta helburua fitxategi berean daude:

          oDoc.CopyToCell("SheetX.A1:F10", "SheetY.C5")

Beheko adibideak erakusten du nola kopiatu barruti bat beste Calc dokumentu ireki batean:

        Dim ui as Variant : ui = CreateScriptService("UI")
        Dim oDocSource As Object, oDocDestination As Object
        'Ireki iturburu-dokumentua atzeko planoan (ezkutuan)
        Set oDocSource = ui.OpenDocument("C:\SourceFile.ods", Hidden := True, ReadOnly := True)
        Set oDocDestination = CreateScriptService("Calc")
        oDocDestination.CopyToCell(oDocSource.Range("Sheet1.C2:C4"), "SheetT.A5")
        'Ez ahaztu iturburu-dokumentua ixtea, ezkutuan ireki baita
        oDocSource.CloseDocument()

##### Python lengoaian

        docSource = svcUI.OpenDocument(r"C:\Documents\SourceFile.ods", hidden = True, readonly = True)
        docDestination = CreateScriptService("Calc")
        docDestination.CopyToCell(docSource.Range("Sheet1.C2:C4"), "SheetT.A5")
        docSource.CloseDocument()

Barruti batetik gelaxka bakar batera kopiatuko/itsatsiko dela simulatzeko, erabili CopyToCell. Barruti batetik barruti handiago batera kopiatuko/itsatsiko dela (gelaxka berak hainbatetan bikoiztuta) simulatzeko, erabili CopyToRange.

## CopyToRange

Beherantz eta/edo eskuinerantz kopiatzen du iturburu-barruti zehatz bat (balioak, formulak eta formatuak) helburuko barruti batean. Metodo horrek iturburu-barruti batetik helburuko barruti handiago batean kopiatzeko/itsasteko eragiketaren portaera imitatzen du.

- Helburuko arearen altuera (edo zabelar) > 1 errenkada (edo zutabe) bada, orduan iturburuaren altuerak (edo zabalerak) helburuaren <= altuera (edo zabalera) izan behar du. Bestela, ez da ezer gertatuko.

- Helburuaren altuera (edo zabalera) = 1 bada, helburua beherantz (edo eskuinerantz) hedatuko da iturburuko barrutiaren altuerara (edo zabalerara) iritsi arte.

Metodoak gelaxka-barruti aldatua ordezkatzen duen kate bat itzultzen du.

Iturburuko barrutia irekitako beste dokumentu batetik etorri daiteke.

### Sintaxia:

svc.CopyToRange(sourcerange: any, destinationrange: str): str

### Parametroak:

sourcerange: Iturburu-barrutia kate gisa, dokumentu berekoa bada, edo erreferentzia gisa, irekita dagoen beste Calc dokumentu bateko bada.

destinationrange: Kopiatutako gelaxka-barrutien helburua, kate gisa.

### Adibidea:

##### Basic lengoaian

Kopiatu dokumentu berearen barruan:

        oDoc.CopyToRange("SheetX.A1:F10", "SheetY.C5:J5")
        ' Barruti-kate bat itzultzen du: "$OrriaY.$C$5:$J$14"

Kopiatu fitxategi batetik beste batera:

        Dim oDocA As Object : Set oDocA = ui.OpenDocument("C:\Documents\FileA.ods", Hidden := True, ReadOnly := True)
        Dim oDocB As Object : Set oDocB = ui.OpenDocument("C:\Documents\FileB.ods")
        oDocB.CopyToRange(oDocA.Range("SheetX.A1:F10"), "SheetY.C5:J5")

##### Python lengoaian

        doc.CopyToRange("OrriaX.A1:F10", "OrriaY.C5:J5")

        docA = svcUI.OpenDocument(r"C:\Documents\FileA.ods", hidden = True, readonly = True)
        docB = svcUI.OpenDocument(r"C:\Documents\FileB.ods")
        docB.CopyToRange(docA.Range("SheetX.A1:F10"), "SheetY.C5:J5")

## DAvg, DCount, DMax, DMin and DSum

Aplikatu Average, Count, Max, Min eta Sum, hurrenez hurren, emandako barruti batean zenbakizko balioak dituzten gelaxka guztiei.

### Sintaxia:

svc.DAvg(range: str): float

svc.DCount(range: str): float

svc.DMax(range: str): float

svc.DMin(range: str): float

svc.DSum(range: str): float

### Parametroak:

range: Funtzioa aplikatuko zaion barrutia, kate gisa.

### Adibidea:

Beheko adibidean Sum funtzioa aplikatzen zaio unean hautatutako orriko "A1:A1000" barrutiari:

##### Basic lengoaian

          result = oDoc.DSum("~.A1:A1000")

##### Python lengoaian

        result = myDoc.DSum("~.A1:A1000")

Emandako barrutian, testua duten gelaxkei ez ikusiarena egingo diete funtzio horiek. Adibidez, DCount metodoak ez ditu zenbatuko testua duten gelaxkak, zenbakiak dituztenak soilik.

## Forms

Emandako parametroen arabera, metodoak honakoa itzuliko du:

- Zeron oinarritutako matrize bat (edo tupla bat Python-en), emandako orri bateko inprimaki guztiak dituena (Form argumenturik ez badago)

- Argumentu gisa zehaztu den inprimakia ordezkatzen duen SFDocuments.Form zerbitzuaren instantzia bat.

### Sintaxia:

svc.Forms(sheetname: str): str[0..*]

svc.Forms(sheetname: str, form: str = ''): svc

svc.Forms(sheetname: str, form: int): svc

### Parametroak:

sheetname: Orri baten izena, kate gisa, zeinetatik inprimakia atzituko den.

form: Zehaztutako orrian biltegiratutako inprimaki baten izena edo hari dagokion indizea. Argumentu hau falta bada, metodoak orrian eskuragarri dauden inprimaki guztien izenak dituen zerrenda bat itzuliko du.

### Adibidea:

Hurrengo adibideetan, lehen lerroak "Orria1" orrian biltegiratutako inprimaki guztien izenak jasotzen ditu eta bigarren lerroak "Orria1" orrian dagoen "Inp_A" izeneko inprimakiaren Form objektua atzitzen du.

##### Basic lengoaian

        Set FormNames = oDoc.Forms("Orria1")
        Set FormA = oDoc.Forms("Orria1", "Inp_A")

##### Python lengoaian

        form_names = doc.Forms("Orria1")
        form_A = doc.Forms("Orria1", "Inp_A")

## GetColumnName

1 eta 1024 zenbakien artean dagoen zutabe-zenbaki bat zenbakiari dagokion letra ('A', 'B', ..., 'AMJ' zutabea) bihurtzen du. Emandako zutabe-zenbakia onartutako barrutitik at badago, zero luzerako kate bat itzuliko da.

### Sintaxia:

svc.GetColumnName(columnnumber: int): str

### Parametroak:

columnnumber: Zutabe-zenbakia 1 ... 1024 tarteko osoko balio gisa.

### Adibidea:

##### Basic lengoaian

Hirugarren zutabearen izena duen mezu-koadro bat bistaratzen du. Modu lehenetsian "C" da izena.

        MsgBox oDoc.GetColumnName(3)

##### Python lengoaian

        sBasic = CreateScriptService("Basic")
        sBasic.MsgBox(myDoc.GetColumnName(3))

Calc orri batean onartzen den gehieneko zutabe kopurua 1024 da.

## GetFormula

Eskuratu emandako gelaxka-barrutian gordetako formula(k) kate bakar gisa edo 1D edo 2D kate-matrize gisa.

### Sintaxia:

svc.GetFormula(range: str): any

### Parametroak:

range: Formulak zein barrutitik eskuratuko diren, kate gisa.

### Adibidea:

##### Basic lengoaian

Hurrengo adibideak 3 x 2 matrize bat itzultzen du, "A1:B3" barrutiko formulak hartuta (3 errenkada x 2 zutabe):

        arrFormula = oDoc.GetFormula("~.A1:B3")

##### Python lengoaian

        arrFormula = myDoc.GetFormula("~.A1:B3")

## GetValue

Eskuratu emandako gelaxka-barrutian gordetako balio(k) kate bakar gisa edo 1D edo 2D kate-matrize gisa. Balio guztiak zenbaki bikoitiak edo kateak dira.

### Sintaxia:

svc.GetValue(range: str): any

### Parametroak:

range: Balioak zein barrutitik eskuratuko diren, kate gisa.

### Adibidea:

##### Basic lengoaian

          arrValues = oDoc.GetValue("~.B1:C100")

##### Python lengoaian

        arrValues = myDoc.GetValue("~.B1:C100")

Gelaxka batek data bat badu, data horri dagokion zenbakia itzuliko da. Zenbakizko balioak data bihurtzeko Basic scriptetan, erabili CDate funtzio integratua. Python scriptetan, erabili Basic zerbitzuaren CDate funtzioa.

## ImportFromCSVFile

CSV formatuko testu-fitxategi bateko edukiak inportatzen ditu eta emandako helburuko gelaxkan kokatzen ditu.

Helburuko areako eduki eta formatu guztiak garbitzen dira CSV fitxategiaren edukiak txertatu baino lehen. Aldatutako arearen tamaina sarrerako fitxategiko edukien araberakoa da.

Metodoak gelaxka-barruti aldatua ordezkatzen duen kate bat itzultzen du.

### Sintaxia:

svc.ImportFromCSVFile(filename: str, destinationcell: str, [filteroptions: str]): str

### Parametroak:

filename: Irekiko den fitxategia identifikatzen du. SF_FileSystem.FileNaming notazioa jarraitu behar du.

destinationcell: Inportatutako datuak txertatuko diren helburuko gelaxka, kate gisa. Barruti bat ematen bada, goiko ezkerreko gelaxka soilik hartuko da kontuan.

filteroptions: Sarrerako CSV fitxategiaren argumentuak. Iragazki lehenetsiak honako baldintzak ematen ditu ontzat:

- Sarrerako fitxategiaren kodeketa UTF8 da.

- Eremu-bereizlea koma bat, puntu eta koma bat edo tabulazio bat da.

- Kate-mugatzailea komatxo bikoitza (") da.

- Lerro guztiak barne daude.

- Komatxo arteko kateei testuaren formatua emango zaie.

- Zenbaki bereziak detektatuko dira.

- Zutabe guztiak testukoak direla suposatuko da, baliozko zenbaki gisa ezagutzen direnean salbu.

- Hizkuntza AEBetako ingelesa da. Horrek inplikatzen du dezimalen bereizlea "." dela eta milakoen bereizlea "," dela.

### Adibidea:

##### Basic lengoaian

        oDoc.ImportFromCSVFile("C:\Temp\myCSVFile.csv", "SheetY.C5")

##### Python lengoaian

        myDoc.ImportFromCSVFile(r"C:\Temp\myCSVFile.csv", "SheetY.C5")

CSV iragazkiaren aukerak ezagutzeko, begiratu iragazki-aukerei buruzko wikiko orria.

## ImportFromDatabase

Datu-base bateko taula, kontsulta edo emaitza multzo baten edukiak inportatzen ditu, alegia SELECT SQL komandoaren emaitza, eta helburuko gelaxka batean txertatzen du.

Helburuko areako eduki eta formatu guztiak garbituko dira inportatutako edukiak txertatu baino lehen. Aldatutako arearen tamaina taulako edo kontsultako edukien araberakoa izango da.

Metodo honek True itzultzen du inportazioa ongi gauzatu denean.

### Sintaxia:

svc.ImportFromDatabase(filename: str = "", registrationname: str = "", destinationcell: str = "", sqlcommand: str = "", directsql: bool): bool

### Parametroak:

filename: Irekiko den fitxategia identifikatzen du. SF_FileSystem.FileNaming notazioa jarraitu behar du.

registrationname: Datu-baseen erregistroan datu-basea aurkitzeko erabiliko den izena. Argumentu honi ez ikusiarena egingo zaio filename ematen bada.

destinationcell: Inportatutako datuen helburua, kate gisa. Barruti bat ematen bada, goiko ezkerreko gelaxka soilik hartuko da kontuan.

sqlcommand: Taula baten edo kontsulta baten izena (inguruan komatxoak edo kortxeteak jarri gabe) edo SELECT SQL instrukzio bat non taularen edo eremuen izenak kortxeteekin edo komatxoekin inguratuta egon daitezkeen instrukzioaren irakurgarritasuna hobetzeko.

directsql: True (egia) denean, SQL komandoa aurretiko analisirik gabe bidaltzen zaio datu-basearen motorrari. Balio lehenetsia False (faltsua) da. Taulen kasuan, ez ikusiarena egiten zaio argumentuari. Kontsultetan, aplikatutako aukera kontsulta definitu zenean ezarritakoa da.

### Adibidea:

##### Basic lengoaian

        oDoc.ImportFromDatabase("C:\Temp\myDbFile.odb", , "SheetY.C5", "SELECT * FROM [Employees] ORDER BY [LastName]")

##### Python lengoaian

        myDoc.ImportFromDatabase(r"C:\Temp\myDbFile.odb", , "SheetY.C5", "SELECT * FROM [Employees] ORDER BY [LastName]")

## InsertSheet

Orri huts berria txertatzen du lehendik dagoen orri baten aurrean edo orrien zerrendaren amaieran.

### Sintaxia:

svc.InsertSheet(sheetname: str, [beforesheet: any]): bool

### Parametroak:

sheetname: Orri berriaren izena.

beforesheet: Orri berria argumentu honetan ezarritako orriaren aurrean txertatuko da. Orriaren izena (katea) edo indizea (zenbakia, 1etik hasita) eman behar da. Argumentu hau aukerakoa da, portaera lehenetsian orria azken posizioan txertatuko da.

### Adibidea:

Hurrengo adibideak "SheetX" izeneko orri hutsa txertatzen du eta "SheetY" orriaren aurrean kokatzen du:

##### Basic lengoaian

        oDoc.InsertSheet("SheetX", "SheetY")

##### Python lengoaian

        myDoc.InsertSheet("SheetX", "SheetY")

## MoveRange

Iturburko barruti bat helburuko gelaxka-barruti batera eramaten du. Metodoak gelaxka-barruti aldatua ordezkatzen duen kate bat itzultzen du. Aldatutako arearen dimentsioak iturburuko arearen tamainaren arabera zehazten dira.

### Sintaxia:

svc.MoveRange(source: str, destination: str): str

### Parametroak:

source: Gelaxken iturburu-barrutia, kate gisa.

destination: Helburuko gelaxka, kate gisa. Barruti bat ematen bada, goiko ezkerreko gelaxka hartuko da helburutzat.

### Adibidea:

##### Basic lengoaian

        oDoc.MoveRange("SheetX.A1:F10", "SheetY.C5")

##### Python lengoaian

        myDoc.MoveRange("SheetX.A1:F10", "SheetY.C5")

## MoveSheet

Lehendik dagoen orri bat lekuz aldatzen du eta zehaztutako orri baten aurrean edo orri-zerrendaren amaieran kokatzen du.

### Sintaxia:

svc.MoveSheet(sheetname: str, [beforesheet: any]): bool

### Parametroak:

sheetname: Lekuz aldatuko den orriaren izena. Orriak existitu behar du, bestela salbuespen bat sortuko da.

beforesheet : Jatorrizko orria zein orriren aurretik txertatuko den. Bigarren orri horren izena (katea) edo indizea (zenbakia, 1etik hasita) eman daiteke. Argumentu hau aukerakoa da eta portaera lehenetsia da orria azken posiziora eramatea.

### Adibidea:

Beheko adibideak lehendik dagoen "SheetX" lekuz aldatzen du eta "SheetY" aurrean kokatzen du:

##### Basic lengoaian

        oDoc.MoveSheet("SheetX", "SheetY")

##### Python lengoaian

        myDoc.MoveSheet("SheetX", "SheetY")

## Offset

Barruti-desplazamendu berri bat itzultzen du (kate gisa). Desplazamendua errenkada eta zutabe kopuru jakin batekoa da, emandako barruti batetik.

Metodo honek Calc aplikazioko izen bereko Offset funtzioaren portaera bera du.

### Sintaxia:

svc.Offset(reference: str, rows: int = 0, columns: int = 0, [height: int], [width: int]): str

### Parametroak:

reference: Desplazamendua gauzatzeko metodoak erreferentzia modura erabiliko duen barrutia, kate gisa.

rows: Hasierako barrutia gorantz (balio negatiboa) edo beherantz (balio positiboa) desplazatuko den errenkada kopurua. Erabili 0 (balio lehenetsia) errenkada berean geratzeko.

columns: Hasierako barrutia ezkerrerantz (balio negatiboa) edo eskuinerantz (balio positiboa) desplazatuko den zutabe kopurua. Erabili 0 (balio lehenetsia) zutabe berean geratzeko.

height: Barruti-kokaleku berrian hasten den area baten altuera bertikala. Ez erabili argumentu hau tamaina bertikala aldatu behar ez denean.

width: Barruti-kokaleku berrian hasten den area baten zabalera horizontala. Ez erabili argumentu hau tamaina horizontala aldatu behar ez denean.

rows eta columns argumentuek ez dute zero edo negatiboa den hasierako errenkada edo zutabera eraman behar.

height eta width argumentuek ez dute zero edo negatiboa den errenkada edo zutabeen kopurua eman behar.

### Adibidea:

##### Basic lengoaian

        oDoc.Offset("A1", 2, 2)
        'SheetX.$C$3 (A1 gelaxka bi errenkada eta bi zutabe beherantz eraman da)
        oDoc.Offset("A1", 2, 2, 5, 6)
        'SheetX.$C$3:$H$7 (A1 gelaxka bi errenkada eta zutabe lekuz aldatu da, 5 errenkadako eta 6 zutabeko zabalerarekin)

##### Python lengoaian

        myDoc.Offset("A1", 2, 2)
        myDoc.Offset("A1", 2, 2, 5, 6)

## RemoveSheet

Lehendik dagoen orri bat dokumentutik kentzen du.

### Sintaxia:

svc.RemoveSheet(sheetname: str): bool

### Parametroak:

OrriIzena: Kenduko den orriaren izena.

### Adibidea:

##### Basic lengoaian

        oDoc.RemoveSheet("SheetY")

##### Python lengoaian

        myDoc.RemoveSheet("SheetY")

## RenameSheet

Emandako orriaren izena aldatzen du eta True itzultzen du ongi aldatzen badu.

### Sintaxia:

svc.RenameSheet(sheetname: str, newname: str): bool

### Parametroak:

sheetname: Izena aldatuko zaion orriaren izena.

newname: Orriaren izen berria. Lehendik ez du izen horrek egon behar.

### Adibidea:

Adibide honetan, orri aktiboari "SheetY" izena ematen zaio:

##### Basic lengoaian

        oDoc.RenameSheet("~", "SheetY")

##### Python lengoaian

        mydoc.RenameSheet("~", "SheetY")

## SetArray

Emandako balioa biltegiratzen du, zehaztutako helburuko gelaxka batean hasita. Eguneratutako area hedatu egingo da helburuko gelaxkatik edo emandako barrutiaren goiko ezkerreko izkinatik, sarrerako value argumentuaren tamainari egokitzeko. Bektoreak bertikalean hedatuko dira beti.

Metodoak area aldatua gelaxka-barruti gisa ordezkatzen duen kate bat itzultzen du.

### Sintaxia:

svc.SetArray(targetcell: str, value: any): str

### Parametroak:

targetcell: Emandako balioa biltegiratzen hasiko den gelaxka edo barrutia (kate gisa).

value: Eskalar bat, bektore bat edo matrize bat (Python lengoiaian, dimentsio bateko edo biko zerrendak eta tuplak), biltegiratuko diren balio berriak dituena. Balioak helburuko gelaxkan hasita edo barrutiaren goiko ezkerreko izkinan hasita, targetcell barruti bat bada, biltegiratuko dira. Balio berriek kateak, zenbakizko balioak edo datak izan behar dute. Beste motak erabiltzen badira, gelaxkak hustu egingo dira.

### Adibidea:

##### Basic lengoaian

Hurrengo adibideak DimArray funtzioa integratua darabil matrize bat sortzeko eta hura "A1" gelaxkan biltegiratzeko:

        Dim arrData as Variant
        arrData = DimArray(2, 1)
        arrData(0, 0) = 1 : arrData(1, 0) = 2 : arrData(2, 0) = 3
        arrData(0, 1) = "One" : arrData(1, 1) = "Two" : arrData(2, 1) = "Three"
        oDoc.SetArray("Sheet1.A1", arrData)

Adibide honek ScriptForge Array zerbitzuaren RangeInit metodoa darabil matrize bat sortu eta, ondoren, matrizeko balioak "A1" gelaxkan eta haren azpikoetan biltegiratzeko.

        'Bete lehen zutabea 1 eta 1000 arteko balioekin
        oDoc.SetArray("Sheet1.A1", SF_Array.RangeInit(1, 1000))

##### Python lengoaian

        arrData = ((1, "One"), (2, "Two"), (3, "Three"))
        myDoc.SetArray("Sheet1.A1", arrData)

        myDoc.SetArray("Sheet1.A1", tuple(i + 1 for i in range(1000)))

Matrize baten eduki osoa orri batean isurtzeko, erabili SetArray. Matrize baten edukiak helburuko gelaxka-barrutian soilik isurtzeko, erabili SetValue.

## SetValue

Emandako balioa zehaztutako barrutian biltegiratzen du. Aldatutako arearen tamaina helburuko barrutiaren tamaina bera izango da.

Metodoak area aldatua gelaxka-barruti gisa ordezkatzen duen kate bat itzultzen du.

### Sintaxia:

svc.SetValue(targetrange: str, value: any): str

### Parametroak:

targetrange: Emandako balioa biltegiratuko den barrutia, kate gisa.

value: Eskalar bat, bektore bat edo matrize bat, barrutiko gelaxka bakoitzerako balio berriak dituena. Balio berriek kateak, zenbakizko balioak edo datak izan behar dute. Beste motak erabiltzen badira, gelaxkak hustu egingo dira.

Barruti osoa eguneratuko da eta orriaren gainerakoa aldaketarik gabe mantenduko da. value balioaren tamaina targetrange balioarena baino txikiagoa bada, gainerako gelaxkak hustu egingo dira.

value balioaren tamaina targetrange balioarena baino handiagoa bada, orduan value partzialki soilik kopiatuko da targetrange elementuaren tamaina bete arte.

Bektoreak bertikalean hedatzen dira, salbu eta targetrange parametroak errenkada bakar bateko altuera badu.

### Adibidea:

##### Basic lengoaian

        oDoc.SetValue("A1", 2)
        'Behean, Value matrizea TargetRange baino txikiagoa da (gainerako gelaxkak hustu egingo dira)
        oDoc.SetValue("A1:F1", Array(1, 2, 3))
        'Behean, Value eta TargetRange barrutiek tamaina bera dute
        oDoc.SetValue("A1:D2", SF_Array.AppendRow(Array(1, 2, 3, 4), Array(5, 6, 7, 8)))

Errenkada bakarra balioekin bete nahi izanez gero, Offset funtzioa erabili daiteke. Beheko adibidean, kontuan hartu arrData dimentsio bakarreko matrizea dela:

        Dim firstCell As String : firstCell = "A1"
        Dim lenArray As Integer : lenArray = UBound(arrData) - LBound(arrData) + 1
        Dim newRange As String : newRange = oDoc.Offset(firstCell, width = lenArray)
        oDoc.SetValue(newRange, arrData)

##### Python lengoaian

        myDoc.SetValue("A1", 2)
        myDoc.SetValue("A1:F1", (1, 2, 3))
        myDoc.SetValue("A1:D2", ((1, 2, 3, 4), (5, 6, 7, 8)))

        firstCell = "A1"
        newRange = doc.Offset(firstCell, width = len(arrData))
        doc.SetValue(newRange, arrData)

## SetCellStyle

Zehaztutako gelaxka-estiloa emandako helburuko barrutiari aplikatzen dio. Barruti osoa eguneratuko da eta orriaren gainerakoa ez da ukituko. Gelaxka-estiloa existitzen ez bada, errore bat sortuko da.

Aldatutako area gelaxken barruti gisa adierazten duen kate bat itzultzen du metodoak.

### Sintaxia:

svc.SetCellStyle(targetrange: str, style: str): str

### Parametroak:

targetrange: Estiloa aplikatuko zaion barrutia, kate gisa.

style: Aplikatuko den gelaxka-estiloaren izena.

### Adibidea:

##### Basic lengoaian

        oDoc.SetCellStyle("A1:J1", "Heading 1")
        oDoc.SetCellStyle("A2:J100", "Neutral")

##### Python lengoaian

        myDoc.SetCellStyle("A1:J1", "Heading 1")
        myDoc.SetCellStyle("A2:J100", "Neutral")

## SetFormula

Emandako formulen (matrizea) zehaztutako barrutian txertatzen du. Aldatutako arearen tamaina eta barrutiaren tamaina berdinak dira.

Aldatutako area gelaxken barruti gisa adierazten duen kate bat itzultzen du metodoak.

### Sintaxia:

svc.SetFormula(targetrange: str, formula: any): str

### Parametroak:

targetrange: Formulak txertatuko diren barrutia, kate gisa.

formula: Helburuko barrutiko gelaxka bakoitzerako formula berriak dituen kate bat, bektore bat edo kateen matrize bat.

Barruti osoa eguneratuko da eta orriaren gainerakoa aldaketarik gabe utziko da.

Emandako formula kate bat bada, formula bakarra barruti osoan itsatsiko da, erreferentzia erlatiboak doituta.

formula barrutiaren tamaina targetrange barrutiarena baino txikiagoa bada, gainerako gelaxkak hustu egingo dira.

formula barrutiaren tamaina targetrange barrutiarena baino handiagoa bada, formulak partzialki soilik kopiatuko dira targetrange barrutiaren tamaina bete arte.

Bektoreak bertikalean hedatzen dira beti, salbu eta targetrange barrutiaren altuera errenkada batekoa bada.

### Adibidea:

##### Basic lengoaian

        oDoc.SetFormula("A1", "=A2")
        'Bektore horizontala, partzialki hutsik
        oDoc.SetFormula("A1:F1", Array("=A2", "=B2", "=C2+10"))
        'D2 gelaxkak "=H2" formula du
        oDoc.SetFormula("A1:D2", "=E1")

##### Python lengoaian

        myDoc.SetFormula("A1", "=A2")
        myDoc.SetFormula("A1:F1", ("=A2", "=B2", "=C2+10"))
        myDoc.SetFormula("A1:D2", "=E1")

## SortRange

Emandako barrutia 1, 2 edo 3 zutabe/errenkadaren arabera ordenatzen du. Ordenatzea aldakorra izan daiteke zutabearen/errenkadaren arabera. Aldatutako gelaxka-barruti bat ordezkatzen duen kate bat itzultzen du. Aldatutako arearen tamaina iturburuko arearen tamainak zehazten du.

### Sintaxia:

svc.SortRange(range: str, sortkeys: any, sortorder: any = "ASC", destinationcell: str = "", containsheader: bool = False, casesensitive: bool = False, sortcolumns: bool = False): str

### Parametroak:

range: Ordenatuko den barrutia, kate gisa.

sortkeys: Eskalar bat (zutabe/errenkada bat erabiltzen bada) edo zutabeen/errenkaden matrize bat, bat baino gehiago erabiltzen bada. Gehieneko gako kopurua 3 da.

sortorder: "ASC" (gorantz), "DESC" (beherantz) edo "" (lehenetsia, gorantz da) balioak dituen eskalar bat edo kateen matrize bat. Elementu bakoitza sortkeys parametroan dagokion elementuarekin parekatuta dago. sortorder matrizea sortkeys baino laburragoa bada, gainerako gakoak gorantz ordenatuko dira.

destinationcell: Ordenatutako gelaxka-barrutiaren helburuko gelaxka, kate gisa. Barruti bat ematen bada, goiko ezkerreko gelaxka soilik erabiliko da. Modu lehenetsian, iturburuko barrutia gainidatzi egingo da.

containsheader: True bada, lehen errenkada/zutabea ez da ordenatuko.

casesensitive: Kate-konparazioetarako soilik. Balio lehenetsia = False

sortcolumns: True (egia) bada, zutabeak ezkerretik eskuinera ordenatuko dira. Balio lehenetsia = False (faltsua): errenkadak goitik behera ordenatuko dira.

### Adibidea:

##### Basic lengoaian

        'Ordenatu barrutia A zutabean (gorantz) eta C zutabean (beherantz) oinarrituta
        oDoc.SortRange("A2:J200", Array(1, 3), Array("ASC", "DESC"), CaseSensitive := True)

##### Python lengoaian

        myDoc.SortRange("A2:J200", (1, 3), ("ASC", "DESC"), casesensitive = True)

Aurrizki gisa azpimarra bat ("_") duten ScriptForge Basic errutina edo identifikatzaile guztiak barneko erabilerarako erreserbatuta daude. Ez daude Basic makroetan erabiltzeko pentsatuta.

Erlazionatutako gaiak

SFDocuments.Document zerbitzua

ScriptForge.UI zerbitzua