├── .gitignore ├── ApiFunction.cls ├── .gitattributes ├── README.md └── xyz.ico /.gitignore: -------------------------------------------------------------------------------- 1 | _Modelos Apis/ 2 | *.xls* 3 | -------------------------------------------------------------------------------- /ApiFunction.cls: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MikelSFraga/ApiFunction/HEAD/ApiFunction.cls -------------------------------------------------------------------------------- /.gitattributes: -------------------------------------------------------------------------------- 1 | # CRLF -> LF by default, but not for modules or classes (especially classes) 2 | * text=auto 3 | *.bas text eol=crlf 4 | *.cls text eol=crlf -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # ApiFunction Class V1.0.1 2 | 3 | Alguns usuários detectaram problemas relacionados ao processo de importação da Classe, para suas máquinas. 4 | Através de algumas esquisas realizadas, foi detectado um erro de configuração do Git, onde o arquivo Cls (que assumem uma estrutura de arquivo texto), estava sendo gravado com caracteres bases do Sistema Operacional Linux, que é padrão no Git. 5 | 6 | Com a descoberta da origem do problema, foi possível realizar uma tratativa nos arquivos, através da alteração desse padrão do Linux, para o mesmo padrão utilizado pelo Windows. 7 | 8 |

9 | 10 | ## ApiFunction Class V1.0.0 11 | 12 | Com o intuito de facilitar o desenvolvimento de ferramentas, utilizando o processo de programação em __VBA do pacote Microsoft Office__, iniciou-se o desenvolvimeno desta __Classe__. 13 | 14 | Seu objetivo é a unificação de várias rotinas que utilizam as __Funções dos Windows (API´s)__, através das quais é possível realizar alterações na estrutura dos __Formulários (Userform´s)__ que utilizamos na estrutura do __Visual Basic for Application (VBA)__. 15 | 16 | Esta __Classe__ atenderá as diferentes _Arquiteturas do Sistema Operacional Windows (32 bits e 64 bits)_, como também as _Arquiteturas do Pacote Microsoft Office (VBA6 e VBA7)_. 17 | 18 | ### Funções Windows (API´s) 19 | 20 | Nesta versão atual do __ApiFunction (v1.0.0)__, são utilizadas as seguintes __Funções/Api´s do Windows__: 21 | 22 | - __FindWindow (user32.dll):__ A função FindWindow recupera o identificador da janela que possui o nome da classe e da janela combinando com textos específicos. Esta função não pesquisa janelas dependentes. 23 | 24 | - __GetWindowLong (user32.dll):__ A função GetWindowLong recupara informação sobre a janela especificada. A função também recupera valores 32-bit (long) específico de uma janela extra da memória de uma janela. 25 | 26 | - __SetWindowLong (user32.dll):__ A função SetWindowLong modifica um atribudo da janela específica. A função também define valores 32-bit (long) específico de uma janela extra da memória de uma janela. 27 | 28 | - __ShowWindow (user32.dll):__ A função ShowWindow define o status específico de exibição da janela. 29 | 30 | - __SetFocus (user32.dll):__ A função SetFocus define o foco do cursor para a janela especificada. A janela deveria estar associada com a fila de mensagens do threads de chamadas. 31 | 32 | - __DrawMenuBar (user32.dll):__ A função DrawMenuBar redesenha a barra de menu da janela especificada. Se a barra de menu for alterada apos o Windows ter creado a janela, esta função deveria ser chamado para desenhar as modificações do menu bar 33 | 34 | - __ExtractIcon (shell32.dll):__ A função ExtractIcon recupera o identificador de um ícone exetutado de um arquivo específicado,de uma biblioteca (DLL) ou de uma imagem do tipo ___ico___. 35 | 36 | - __SendMessage (user32.dll):__ A função SendMessage envia a mensagem especificada para uma janela(s). A função chama o procedimento da janela para a janela especificada e não retorna até que o procedimento da janela tenha processado a mensagem. A função PostMessage, em contrapartida, posta uma mensagem para uma lista de mensagem em thread e retorna imediatamente. 37 | 38 | - __SetLayeredWindowAttributes (user32.dll):__ A função SetLayeredWindowAttributes define a opacidade e cor chave de transparência de uma camada da janela. 39 | 40 | - __SetParent (user32.dll):__ A função SetParent altera a janela pai de uma janela filha especificada. 41 | 42 | Caso tenham interesse em conhecer mais sobre as API´s do Windows, podem acessar o site [AllAPI.net](http://allapi.mentalis.org/index2.shtml) e acessar a [Lista de Api´s](http://allapi.mentalis.org/apilist/apilist.php). 43 | 44 | ### Métodos e Propriedades Classe 45 | 46 | Com base nas Funções acima, foram criados ___Propriedades___ e ___Métodos___ para esta __Classe__, que irá funcionar como um ___Framework de Projetos VBA___, para realizar alterações na estrutura física do __Formulário (Userform)__. Seguem relação e descrição, de todos os recursos que a __Classe__ oferece. 47 | Ressaltando que os nomes das ___Propriedades___ e ___Métodos___ são em Inglês, para seguir o padrão da língua estrangeira, utilizada como base para a __Programação VBA__. 48 | 49 | #### Propriedades 50 | 51 | ##### FormStart 52 | 53 | Essa propriedade nos permite instanciar o ___Objeto da Classe___, definindo o __Formulário (Userform)__ que será manipulado/personalizado. Definindo essa propriedade, todas as demais já estarão direcionando seus resultados para o __Formulário (Userform)__ definido. 54 | 55 | __Exemplo:__ 56 | ```vb 57 | Option Explicit 58 | 59 | Private Sub UserForm_Initialize() 60 | ' Declaração do objeto da classe. 61 | Dim objApi As New ApiFunction 62 | ' Define o Userform para sub-objeto da classe. 63 | Set objApi.FormStart = UserForm1 64 | End Sub 65 | ``` 66 | 67 | ##### ActivateButtons 68 | 69 | Essa propriedade permite que o desenvolvedor insira os botões de Maximizar e Minimizar, sejam individualmente ou ambos. Para isso, é necessário a selação de uma das seguintes opções: 70 | - __WS_FULLSIZING:__ ativa, de uma só vez, os dois botões (Maximizar e Minimizar); 71 | - __WS_MAXIMIZE:__ ativa somente o botão de Maximizar. O botão de Minimizar fica visível, mas desabilitado para uso; 72 | - __WS_MINIMIZE:__ ativa somente o botão de Minimizar. O botão de Maximizar fica visível, mas desabilitado para uso. 73 | 74 | __Exemplo:__ 75 | ```vb 76 | Option Explicit 77 | 78 | Private Sub UserForm_Initialize() 79 | ' Declaração do objeto da classe. 80 | Dim objApi As New ApiFunction 81 | ' Define o Userform para sub-objeto da classe. 82 | Set objApi.FormStart = UserForm1 83 | ' Chama a propriedade que irá ativar os botões Minimizar 84 | ' e Maximizar os botões na estrutura do Userform. 85 | objApi.ActivateButtons = WS_FULLSIZING 86 | End Sub 87 | ``` 88 | 89 | ##### IconTitleBarForm 90 | 91 | Através desta propriedade, é possível inserir um __Ícone na Barra de Título do Userform__. É preciso apenas informar o caminho onde o arquivo se encontra, para que possa ser passado para as rotinas da propriedade realizarem a transação da imagem para o userform. 92 | 93 | __Exemplo:__ 94 | ```vb 95 | Option Explicit 96 | 97 | Private Sub UserForm_Initialize() 98 | ' Declaração do objeto da classe. 99 | Dim objApi As New ApiFunction 100 | ' Define o Userform para sub-objeto da classe. 101 | Set objApi.FormStart = UserForm1 102 | ' Passa para a propriedade a localização da imagem 103 | ' que será inserida na Barra de título do Userform. 104 | objApi.IconTitleBarForm = ThisWorkbook.Path & "\xyz.ico" 105 | End Sub 106 | ``` 107 | 108 | ##### OpacityPercent 109 | 110 | Essa propriedade define o __Percentual de Opacidade__, ou seja, a ___Transparência que um Userform___ pode possuir. Geralmente esse é iniciado com __100%__, mas o desenvolvedor pode quere desenvolver um formulário com apenas __60% de Opacidade__. Basta apenas passar o valor da porcentagem desejada. 111 | 112 | __Exemplo:__ 113 | ```vb 114 | Option Explicit 115 | 116 | Private Sub UserForm_Initialize() 117 | ' Declaração do objeto da classe. 118 | Dim objApi As New ApiFunction 119 | ' Define o Userform para sub-objeto da classe. 120 | Set objApi.FormStart = UserForm1 121 | ' Define o percentual de opacidade para Userform. 122 | objApi.OpacityPercent = 60 123 | End Sub 124 | ``` 125 | 126 | #### Métodos 127 | 128 | ##### RemoveTitleBar 129 | 130 | Esse método, quando chamado, remove a __Barra de Título do Userform__ definido, quando o __Objeto da Classe__ foi iniciado. 131 | 132 | __Exemplo:__ 133 | ```vb 134 | Option Explicit 135 | 136 | Private Sub UserForm_Initialize() 137 | ' Declaração do objeto da classe. 138 | Dim objApi As New ApiFunction 139 | ' Define o Userform para sub-objeto da classe. 140 | Set objApi.FormStart = UserForm1 141 | ' Remove a Barra de Título do Userform. 142 | objApi.RemoveTitleBar 143 | End Sub 144 | ``` 145 | 146 | ##### HideCloseButton 147 | 148 | Esse método, quando chamado, oculta o __Botão Fechar da Barra de Título do Userform__ definido, quando o __Objeto da Classe__ foi iniciado. 149 | 150 | __Exemplo:__ 151 | ```vb 152 | Option Explicit 153 | 154 | Private Sub UserForm_Initialize() 155 | ' Declaração do objeto da classe. 156 | Dim objApi As New ApiFunction 157 | ' Define o Userform para sub-objeto da classe. 158 | Set objApi.FormStart = UserForm1 159 | ' Esconde o botão Fechar (X) do Userform. 160 | objApi.HideCloseButton 161 | End Sub 162 | ``` 163 | 164 | ##### ActivateDualButtons 165 | 166 | Esse método, quando chamado, ativa os botões de __Maximizar e Minimizar na Barra de Título do Userform__ definido. Executa a mesma função que a ___Propriedade ActiveButtons___, mas não é preciso passar parâmetro para a execução. 167 | 168 | __Exemplo:__ 169 | ```vb 170 | Option Explicit 171 | 172 | Private Sub UserForm_Initialize() 173 | ' Declaração do objeto da classe. 174 | Dim objApi As New ApiFunction 175 | ' Define o Userform para sub-objeto da classe. 176 | Set objApi.FormStart = UserForm1 177 | ' Ativa os botões de Minimizar e Maximizar do 178 | ' Userform, como na Propriedade ActivateButtons. 179 | objApi.ActivateDualButtons 180 | End Sub 181 | ``` 182 | 183 | 184 | ##### ActivateMaximizeOnly 185 | 186 | Esse método, quando chamado, ativa somente o botão de __Maximizar na Barra de Título do Userform__ definido. Executa a mesma função que a ___Propriedade ActiveButtons___, mas não é preciso passar parâmetro para a execução. 187 | 188 | __Exemplo:__ 189 | ```vb 190 | Option Explicit 191 | 192 | Private Sub UserForm_Initialize() 193 | ' Declaração do objeto da classe. 194 | Dim objApi As New ApiFunction 195 | ' Define o Userform para sub-objeto da classe. 196 | Set objApi.FormStart = UserForm1 197 | ' Ativa somente o botão de Maximizar do 198 | ' Userform, como na Propriedade ActivateButtons. 199 | objApi.ActivateMaximizeOnly 200 | End Sub 201 | ``` 202 | 203 | 204 | ##### ActivateMinimizeOnly 205 | 206 | Esse método, quando chamado, ativa somente o botão de __Minimizar na Barra de Título do Userform__ definido. Executa a mesma função que a ___Propriedade ActiveButtons___, mas não é preciso passar parâmetro para a execução. 207 | 208 | __Exemplo:__ 209 | ```vb 210 | Option Explicit 211 | 212 | Private Sub UserForm_Initialize() 213 | ' Declaração do objeto da classe. 214 | Dim objApi As New ApiFunction 215 | ' Define o Userform para sub-objeto da classe. 216 | Set objApi.FormStart = UserForm1 217 | ' Ativa somente o botão de Minimizar do 218 | ' Userform, como na Propriedade ActivateButtons. 219 | objApi.ActivateMinimizeOnly 220 | End Sub 221 | ``` 222 | 223 | 224 | ##### ShowFormTaskBar * 225 | 226 | Esse método, quando chamado, extende o acesso ao __Userform para a Barra de Tarefas do Windows__. Desta forma, não se torna obrigatório o acesso a esse userform, unica e exclusivamente pelo __Applicativo Office__. 227 | 228 | __Exemplo:__ 229 | ```vb 230 | Option Explicit 231 | 232 | Private Sub UserForm_Initialize() 233 | ' Declaração do objeto da classe. 234 | Dim objApi As New ApiFunction 235 | ' Define o Userform para sub-objeto da classe. 236 | Set objApi.FormStart = UserForm1 237 | ' Ativa o Userform na Barra de Tarefas do Window. 238 | objApi.ShowFormTaskBar 239 | End Sub 240 | ``` 241 | 242 | 243 | ##### ParentForms * 244 | 245 | Esse método, quando chamado, define um segundo userform como um __Userform Pai__ do userform atual. Isso significa que o __Userform Filho__ fica limitado a área do __Userform Pai__. 246 | 247 | __Exemplo:__ 248 | ```vb 249 | Option Explicit 250 | 251 | Private Sub UserForm_Initialize() 252 | ' Declaração do objeto da classe. 253 | Dim objApi As New ApiFunction 254 | ' Instancia o novo objeto, a partir da classe. 255 | Set objApi = New ApiFunction 256 | ' Define relação enre dos Userforms. 257 | objApi.ParentForms UserForm2.Caption, UserForm1.Caption 258 | End Sub 259 | ``` 260 | 261 | * Existem alguns __Métodos__ e __Propriedades__ que irão gerar erros, se o valor da propriedade ___ShowModal___ de um __Useform__, não for alterado para _False_. Uma forma de se fazer isso via código, é passar o parâmetro ___vbModeless___, no método __Show__, utilizado para a abertura de um __Userform__. -------------------------------------------------------------------------------- /xyz.ico: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | ApiFunction/xyz.ico at master · MikelSFraga/ApiFunction 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | 73 | 74 | 75 | 76 | 77 | 78 | 79 | 80 | 81 | 82 | 83 | 84 | 85 | 86 | 87 | 88 | 89 | 90 | 91 | 92 | 93 | 94 | 95 | 96 | 97 | 98 | 99 | 100 | 101 | 102 | 103 | 104 | 105 | 106 | 107 | 108 | 109 |

110 | 111 |

112 | 113 | 114 | 115 | 116 | 117 | 118 | 119 | 120 | 327 | 328 | 329 | 330 |

331 | 332 |

333 | 334 |

335 |

336 | 337 | 338 | 339 |

340 |

341 |

342 | 343 | 344 | 345 | 346 | 347 | 348 | 349 | 350 |

351 |

352 | 353 |

355 |
356 | 357 |
358 | 365 | 366 | 367 | Unwatch 368 | 369 | 370 | 373 | 2 374 | 375 | 376 |
377 |
378 |
379 | 380 | Notifications 381 |
382 | 383 |
384 | 385 |
386 | 387 |
388 | 389 | Not watching 390 | Be notified when participating or @mentioned. 391 | 392 | 393 | Watch 394 | 395 |
396 |
397 | 398 |
399 | 400 |
401 | 402 | Watching 403 | Be notified of all conversations. 404 | 405 | 406 | Unwatch 407 | 408 |
409 |
410 | 411 |
412 | 413 |
414 | 415 | Ignoring 416 | Never be notified. 417 | 418 | 419 | Stop ignoring 420 | 421 |
422 |
423 | 424 |
425 | 426 |
427 |
428 |
429 |
430 |
433 | 434 |
435 |
436 | 437 | 445 | 447 | 2 448 | 449 |
450 |
451 | 452 | 460 | 462 | 2 463 | 464 |

465 | 466 |
469 |
470 | 479 |
480 | 482 | 0 483 | 484 |

486 | 487 |

488 | 489 | MikelSFraga/ApiFunction 492 | 493 |

494 | 495 |

496 | 497 | 545 | 546 | 547 |

548 | 549 |

550 |

551 | 552 | 553 | 554 | 555 | 556 | 557 |

558 | 559 |

560 | 566 | 567 | 641 |

642 | 643 |

644 | 648 | Find file 649 | 650 | 651 | Copy path 652 | 653 |

654 | 657 |

658 | 659 | 660 | 661 |

662 | Fetching contributors… 663 |

664 | 665 |

666 |

667 | Cannot retrieve contributors at this time 668 |

669 | 670 | 671 | 672 |

673 |

674 |

675 | 676 |

677 | Download 678 | History 679 |

680 | 681 | 685 | 686 | 687 | 688 |

694 | 695 |

696 | 218 KB 697 |

698 |

699 | 700 | 701 | 702 |

703 |

704 | View Raw 705 |

706 |

707 | 708 |

709 | 710 | 711 | 716 | 717 | 718 |

719 | 720 |

721 | 722 |

723 |

724 | 725 |

726 | 727 | 728 | 756 | 757 | 758 | 759 |

760 | 761 | 764 | You can’t perform that action at this time. 765 |

766 | 767 | 768 | 769 | 770 | 771 | 772 | 773 | 774 | 775 | 780 | 789 | 790 | 794 | 795 | 798 | 799 | 800 | 801 | 802 | 803 | --------------------------------------------------------------------------------